Microsoft.DBforPostgreSQL (stable:2022-11-08)

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

Clusters_List (new)
Description :  Lists all clusters in a 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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of clusters ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of cluster list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Lists all clusters in a 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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of clusters ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of cluster list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Deletes a cluster together with servers in it.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’.  ,
Format: password ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
coordinatorServerEdition:
{
Description: The edition of the coordinator (default: GeneralPurpose). ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of the coordinator in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of the coordinator (max: 96). ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByCluster (new)
Description :  Lists servers of a cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a server in a cluster. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the cluster. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
haState:
{
Description: A state of HA feature for the cluster. ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability Zone information of the server. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version of server. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version of server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of cluster configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of configuration. ,
Required: False ,
}
{
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
serverRoleGroupConfigurations:
{
Description: The list of server role group configuration values. ,
Required: True ,
}
[
{
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the configuration ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_Get (new)
Description :  Gets information of a configuration for coordinator and nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_GetCoordinator (new)
Description :  Gets information of a configuration for coordinator.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_UpdateOnCoordinator (new)
Description :  Updates configuration of coordinator in a cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_GetNode (new)
Description :  Gets information of a configuration for worker nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_UpdateOnNode (new)
Description :  Updates configuration of worker nodes in a cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates a new cluster firewall rule or updates an existing cluster firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the cluster firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_Get (new)
Description :  Gets information about a cluster role.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_Create (new)
Description :  Creates a new role or updates an existing role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the cluster role. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a role. ,
Required: True ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster role. ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_ListByCluster (new)
Description :  List all the roles in a given cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of roles in a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Restart (new)
Description :  Restarts all nodes in the cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Start (new)
Description :  Starts stopped compute on all cluster nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Stop (new)
Description :  Stops compute on all cluster nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_PromoteReadReplica (new)
Description :  Promotes read replica cluster to an independent read-write cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CheckNameAvailability (new)
Description :  Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByCluster (new)
Description :  Gets the private link resources for cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource for cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_List (removed)
Description :  Lists all clusters in a 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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of clusters ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of cluster list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  Lists all clusters in a 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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of clusters ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of cluster list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Create (removed)
Description :  Creates a new cluster with servers.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (removed)
Description :  Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (removed)
Description :  Deletes a cluster together with servers in it.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (removed)
Description :  Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a cluster. ,
Required: True ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLoginPassword:
{
Description: The password of the administrator login. Each cluster is created with pre-defined administrative role called ‘citus’.  ,
Format: password ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
coordinatorServerEdition:
{
Description: The edition of the coordinator (default: GeneralPurpose). ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of the coordinator in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of the coordinator (max: 96). ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster. ,
}
{
properties:
{
Description: Properties of the cluster. ,
Required: False ,
}
{
administratorLogin:
{
Description: The administrator's login name of the servers in the cluster. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The password of the administrator login. Required for creation. ,
Format: password ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the cluster ,
Required: False ,
}
string ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version on all cluster servers. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version on all cluster servers. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: Maintenance window of a cluster. ,
Required: False ,
}
{
customWindow:
{
Description: Indicates whether custom maintenance window is enabled or not. ,
Required: False ,
}
string ,
startHour:
{
Description: Start hour within preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
startMinute:
{
Description: Start minute within the start hour for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Preferred day of the week for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
preferredPrimaryZone:
{
Description: Preferred primary availability zone (AZ) for all cluster servers. ,
Required: False ,
}
string ,
enableShardsOnCoordinator:
{
Description: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed. ,
Required: False ,
}
boolean ,
enableHa:
{
Description: If high availability (HA) is enabled or not for the cluster. ,
Required: False ,
}
boolean ,
coordinatorServerEdition:
{
Description: The edition of a coordinator server (default: GeneralPurpose). Required for creation. ,
Required: False ,
}
string ,
coordinatorStorageQuotaInMb:
{
Description: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorVCores:
{
Description: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinatorEnablePublicIpAccess:
{
Description: If public access is enabled on coordinator. ,
Required: False ,
}
boolean ,
nodeServerEdition:
{
Description: The edition of a node server (default: MemoryOptimized). ,
Required: False ,
}
string ,
nodeCount:
{
Description: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeStorageQuotaInMb:
{
Description: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeVCores:
{
Description: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeEnablePublicIpAccess:
{
Description: If public access is enabled on worker nodes. ,
Required: False ,
}
boolean ,
serverNames:
{
Description: The list of server names in the cluster ,
Required: False ,
}
[
{
name:
{
Description: The name of a server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
}
,
]
,
sourceResourceId:
{
Description: The resource id of source cluster for read replica clusters. ,
Required: False ,
}
string ,
sourceLocation:
{
Description: The Azure region of source cluster for read replica clusters. ,
Required: False ,
}
string ,
pointInTimeUTC:
{
Description: Date and time in UTC (ISO8601 format) for cluster restore. ,
Format: date-time ,
Required: False ,
}
string ,
readReplicas:
{
Description: The array of read replica clusters. ,
Required: False ,
}
[
string ,
]
,
earliestRestoreTime:
{
Description: The earliest restore point time (ISO8601 format) for the cluster. ,
Format: date-time ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The private endpoint connections for a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group ids of the private endpoint connection. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByCluster (removed)
Description :  Lists servers of a cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a server in a cluster. ,
Required: False ,
}
{
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of a server. ,
Required: False ,
}
string ,
role:
{
Description: The role of server in the cluster. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: A state of a cluster/server that is visible to user. ,
Required: False ,
}
string ,
haState:
{
Description: A state of HA feature for the cluster. ,
Required: False ,
}
string ,
availabilityZone:
{
Description: Availability Zone information of the server. ,
Required: False ,
}
string ,
postgresqlVersion:
{
Description: The major PostgreSQL version of server. ,
Required: False ,
}
string ,
citusVersion:
{
Description: The Citus extension version of server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of cluster configurations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of configuration. ,
Required: False ,
}
{
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
serverRoleGroupConfigurations:
{
Description: The list of server role group configuration values. ,
Required: True ,
}
[
{
role:
{
Description: The role of servers in the server role group. ,
Enum:
{
Coordinator: No description available. ,
Worker: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the configuration ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_Get (removed)
Description :  Gets information of a configuration for coordinator and nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_GetCoordinator (removed)
Description :  Gets information of a configuration for coordinator.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_UpdateOnCoordinator (removed)
Description :  Updates configuration of coordinator in a cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/coordinatorConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_GetNode (removed)
Description :  Gets information of a configuration for worker nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_UpdateOnNode (removed)
Description :  Updates configuration of worker nodes in a cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/nodeConfigurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the cluster configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a cluster configuration. ,
Required: True ,
}
{
properties:
{
Description: The properties of a configuration. ,
Required: False ,
}
{
value:
{
Description: Value of the configuration. ,
Required: True ,
}
string ,
source:
{
Description: Source of the configuration. ,
Required: False ,
}
string ,
description:
{
Description: Description of the configuration. ,
Required: False ,
}
string ,
defaultValue:
{
Description: Default value of the configuration. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the configuration. ,
Enum:
{
Boolean: No description available. ,
Numeric: No description available. ,
Integer: No description available. ,
Enumeration: No description available. ,
}
,
Required: False ,
}
enum ,
allowedValues:
{
Description: Allowed values of the configuration. ,
Required: False ,
}
string ,
requiresRestart:
{
Description: If configuration change requires restart. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (removed)
Description :  Creates a new cluster firewall rule or updates an existing cluster firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/firewallRules/{firewallRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the cluster firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of a firewall rule. ,
Required: True ,
}
{
startIpAddress:
{
Description: The start IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
endIpAddress:
{
Description: The end IP address of the cluster firewall rule. Must be IPv4 format. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the firewall rule. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_Get (removed)
Description :  Gets information about a cluster role.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_Create (removed)
Description :  Creates a new role or updates an existing role.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
roleName:
{
Description: The name of the cluster role. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a role. ,
Required: True ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
azure-async-operation: string ,
}
,
$schema:
{
Description: Represents a cluster role. ,
}
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Roles_ListByCluster (removed)
Description :  List all the roles in a given cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of roles in a cluster. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a role. ,
Required: True ,
}
{
password:
{
Description: The password of the cluster role. ,
Format: password ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the role ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Restart (removed)
Description :  Restarts all nodes in the cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Start (removed)
Description :  Starts stopped compute on all cluster nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Stop (removed)
Description :  Stops compute on all cluster nodes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_PromoteReadReplica (removed)
Description :  Promotes read replica cluster to an independent read-write cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CheckNameAvailability (removed)
Description :  Checks availability of a cluster name. Cluster names should be globally unique; at least 3 characters and at most 40 characters long; they must only contain lowercase letters, numbers, and hyphens; and must not start or end with a hyphen.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByCluster (removed)
Description :  Gets list of private endpoint connections on a cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{
location: string ,
azure-async-operation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByCluster (removed)
Description :  Gets the private link resources for cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets a private link resource for cluster.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}