Microsoft.DBForPostgreSql (preview:2020-10-05-privatepreview)

2025/09/12 • 24 new, 24 deleted methods

ServerGroups_List (new)
Description :  List all the server groups in a given subscription.
Reference :  Link ¶

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

⚐ Response (200)

{
value:
{
Description: The list of server groups ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_ListByResourceGroup (new)
Description :  List all the server groups in a given resource group.
Reference :  Link ¶

⚼ 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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server groups ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_CreateOrUpdate (new)
Description :  Creates a new server group with servers.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server group. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Get (new)
Description :  Gets information about a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Delete (new)
Description :  Deletes a server group together with servers in it.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Update (new)
Description :  Updates an existing server group. The request body can contain one to many of the properties present in the normal server group definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a server group. ,
Required: True ,
}
{
location:
{
Description: The location the resource resides in. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the server group. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Servers_ListByServerGroup (new)
Description :  Lists servers of a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of servers in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a server in a server group. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the server group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: A state of a server group that is visible to user for HA feature. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
NotSync: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of a servers in server group. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The PostgreSQL version of server. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Servers_Get (new)
Description :  Gets information about a server in server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a server in a server group. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the server group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: A state of a server group that is visible to user for HA feature. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
NotSync: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of a servers in server group. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The PostgreSQL version of server. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_ListByServer (new)
Description :  List all the configurations of a server in server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_ListByServerGroup (new)
Description :  List all the configurations of a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server group configurations. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_Update (new)
Description :  Updates configuration of server role groups in a server group
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the server group configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server group configuration. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_Get (new)
Description :  Gets information about single server group configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the server group configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes a server group firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_Get (new)
Description :  Gets information about a server group firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_ListByServerGroup (new)
Description :  List all the firewall rules in a given server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of firewall rules in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Create (new)
Description :  Creates a new role or updates an existing role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the server group role name. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a role. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Delete (new)
Description :  Deletes a server group role.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the server group role name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_ListByServerGroup (new)
Description :  List all the roles in a given server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of roles in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Restart (new)
Description :  Restarts the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Start (new)
Description :  Starts the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Stop (new)
Description :  Stops the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_CheckNameAvailability (new)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: Resource 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 resource name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: name of the PostgreSQL server. ,
Required: False ,
}
string ,
type:
{
Description: type of the server ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_List (removed)
Description :  List all the server groups in a given subscription.
Reference :  Link ¶

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

⚐ Response (200)

{
value:
{
Description: The list of server groups ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_ListByResourceGroup (removed)
Description :  List all the server groups in a given resource group.
Reference :  Link ¶

⚼ 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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server groups ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_CreateOrUpdate (removed)
Description :  Creates a new server group with servers.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a server group. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Get (removed)
Description :  Gets information about a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Delete (removed)
Description :  Deletes a server group together with servers in it.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Update (removed)
Description :  Updates an existing server group. The request body can contain one to many of the properties present in the normal server group definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a server group. ,
Required: True ,
}
{
location:
{
Description: The location the resource resides in. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the server group. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the server group create. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a new server group. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
ReadReplica: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of servers in server group. Can only be specified when the server is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. ,
Format: password ,
Required: False ,
}
string ,
backupRetentionDays:
{
Description: The backup retention days for server group. ,
Format: int32 ,
Required: False ,
}
integer ,
postgresqlVersion:
{
Description: The PostgreSQL version of server group. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server group. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
enableMx:
{
Description: If Citus MX is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableZfs:
{
Description: If ZFS compression is enabled or not for the server group. ,
Required: False ,
}
boolean ,
enableShardsOnCoordinator:
{
Description: If shards on coordinator is enabled or not for the server group. ,
Required: False ,
}
boolean ,
state:
{
Description: A state of a server group that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for server group. ,
Format: date-time ,
Required: False ,
}
string ,
resourceProviderType:
{
Description: The resource provider type of server group. ,
Enum:
{
Meru: No description available. ,
Marlin: No description available. ,
}
,
Required: False ,
}
enum ,
serverRoleGroups:
{
Description: The list of server role groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the server role group. ,
Required: False ,
}
string ,
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
serverCount:
{
Description: The number of servers in the server role group. ,
Format: int32 ,
Required: False ,
}
integer ,
serverNames:
{
Description: The list of server names in the server role group. ,
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 ,
}
,
]
,
}
,
]
,
maintenanceWindow:
{
Description: Maintenance window of a server group. ,
Required: False ,
}
{
customWindow:
{
Description: indicates whether custom window is enabled or disabled ,
Required: False ,
}
string ,
startHour:
{
Description: start hour for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: start minute for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: day of week for maintenance window ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
delegatedSubnetArguments:
{
Description: The delegated subnet arguments for a server group. ,
Required: False ,
}
{
subnetArmResourceId:
{
Description: delegated subnet arm resource id. ,
Required: False ,
}
string ,
}
,
privateDnsZoneArguments:
{
Description: The private dns zone arguments for a server group. ,
Required: False ,
}
{
privateDnsZoneArmResourceId:
{
Description: private dns zone arm resource id. ,
Required: False ,
}
string ,
}
,
readReplicas:
{
Description: The array of read replica server groups. ,
Required: False ,
}
[
string ,
]
,
sourceServerGroup:
{
Description: The source server group id for read replica server groups. ,
Required: False ,
}
string ,
sourceSubscriptionId:
{
Description: The source subscription id to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceResourceGroupName:
{
Description: The source resource group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceServerGroupName:
{
Description: The source server group name to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The source server group location to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'ReadReplica' ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Servers_ListByServerGroup (removed)
Description :  Lists servers of a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of servers in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a server in a server group. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the server group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: A state of a server group that is visible to user for HA feature. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
NotSync: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of a servers in server group. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The PostgreSQL version of server. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Servers_Get (removed)
Description :  Gets information about a server in server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers/{serverName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a server in a server group. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the server group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a server that is visible to user. ,
Enum:
{
Ready: No description available. ,
Dropping: No description available. ,
Disabled: No description available. ,
Starting: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Updating: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
haState:
{
Description: A state of a server group that is visible to user for HA feature. ,
Enum:
{
NotEnabled: No description available. ,
CreatingStandby: No description available. ,
ReplicatingData: No description available. ,
FailingOver: No description available. ,
Healthy: No description available. ,
RemovingStandby: No description available. ,
NotSync: No description available. ,
}
,
Required: False ,
}
enum ,
administratorLogin:
{
Description: The administrator's login name of a servers in server group. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The PostgreSQL version of server. ,
Enum:
{
11: No description available. ,
12: No description available. ,
}
,
Required: False ,
}
enum ,
citusVersion:
{
Description: The Citus version of server. ,
Enum:
{
8.3: No description available. ,
9.0: No description available. ,
9.1: No description available. ,
9.2: No description available. ,
9.3: No description available. ,
9.4: No description available. ,
9.5: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Availability Zone information of the server group. ,
Required: False ,
}
string ,
standbyAvailabilityZone:
{
Description: Standby Availability Zone information of the server group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_ListByServer (removed)
Description :  List all the configurations of a server in server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/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. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server configurations. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_ListByServerGroup (removed)
Description :  List all the configurations of a server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of server group configurations. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_Update (removed)
Description :  Updates configuration of server role groups in a server group
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the server group configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server group configuration. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Configurations_Get (removed)
Description :  Gets information about single server group configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the server group configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of server group 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 ,
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 ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_CreateOrUpdate (removed)
Description :  Creates a new firewall rule or updates an existing firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_Delete (removed)
Description :  Deletes a server group firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_Get (removed)
Description :  Gets information about a server group firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the server group firewall rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FirewallRules_ListByServerGroup (removed)
Description :  List all the firewall rules in a given server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/firewallRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of firewall rules in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the server group firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Create (removed)
Description :  Creates a new role or updates an existing role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the server group role name. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a role. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_Delete (removed)
Description :  Deletes a server group role.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the server group role name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Roles_ListByServerGroup (removed)
Description :  List all the roles in a given server group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of roles in a server group. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a role. ,
Required: False ,
}
{
password:
{
Description: The password of the server group role. ,
Format: password ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Restart (removed)
Description :  Restarts the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Start (removed)
Description :  Starts the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_Stop (removed)
Description :  Stops the server group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
serverGroupName:
{
Description: The name of the server group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ServerGroups_CheckNameAvailability (removed)
Description :  Check the availability of name for resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: The required parameters for checking if resource name is available. ,
Required: True ,
}
{
name:
{
Description: Resource 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 resource name is available. ,
Required: False ,
}
boolean ,
name:
{
Description: name of the PostgreSQL server. ,
Required: False ,
}
string ,
type:
{
Description: type of the server ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}