Microsoft.DBforPostgreSQL (preview:2024-11-01)

2024/12/03 • 1 updated methods

Servers_Update (updated)
Description Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
Reference Link ¶

⚶ Changes

{
  "#id": "Servers_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "@added_a898ba108895484aa32a9060a03ae782": {
              "#name": "cluster",
              "Description": "Cluster properties of a server.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "clusterSize",
                  "Description": "The node count for the cluster.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
serverName: string ,
parameters:
{
sku:
{
name: string ,
tier: enum ,
}
,
identity:
{
userAssignedIdentities: object ,
type: enum ,
tenantId: string ,
}
,
properties:
{
administratorLogin: string ,
administratorLoginPassword: string ,
version: enum ,
storage:
{
storageSizeGB: integer ,
autoGrow: enum ,
tier: enum ,
iops: integer ,
throughput: integer ,
type: enum ,
}
,
backup:
{
backupRetentionDays: integer ,
geoRedundantBackup: enum ,
earliestRestoreDate: string ,
}
,
highAvailability:
{
mode: enum ,
state: enum ,
standbyAvailabilityZone: string ,
}
,
maintenanceWindow:
{
customWindow: string ,
startHour: integer ,
startMinute: integer ,
dayOfWeek: integer ,
}
,
authConfig:
{
activeDirectoryAuth: enum ,
passwordAuth: enum ,
tenantId: string ,
}
,
dataEncryption:
{
primaryKeyURI: string ,
primaryUserAssignedIdentityId: string ,
geoBackupKeyURI: string ,
geoBackupUserAssignedIdentityId: string ,
type: enum ,
primaryEncryptionKeyStatus: enum ,
geoBackupEncryptionKeyStatus: enum ,
}
,
createMode: enum ,
replicationRole: enum ,
replica:
{
role: enum ,
capacity: integer ,
replicationState: enum ,
promoteMode: enum ,
promoteOption: enum ,
}
,
network:
{
publicNetworkAccess: enum ,
delegatedSubnetResourceId: string ,
privateDnsZoneArmResourceId: string ,
}
,
cluster:
{
clusterSize: integer ,
}
,
}
,
tags: object ,
}
,
}

⚐ Response (200)

{
sku:
{
name: string ,
tier: enum ,
}
,
identity:
{
userAssignedIdentities: object ,
type: enum ,
tenantId: string ,
}
,
properties:
{
administratorLogin: string ,
administratorLoginPassword: string ,
version: enum ,
minorVersion: string ,
state: enum ,
fullyQualifiedDomainName: string ,
storage:
{
storageSizeGB: integer ,
autoGrow: enum ,
tier: enum ,
iops: integer ,
throughput: integer ,
type: enum ,
}
,
authConfig:
{
activeDirectoryAuth: enum ,
passwordAuth: enum ,
tenantId: string ,
}
,
dataEncryption:
{
primaryKeyURI: string ,
primaryUserAssignedIdentityId: string ,
geoBackupKeyURI: string ,
geoBackupUserAssignedIdentityId: string ,
type: enum ,
primaryEncryptionKeyStatus: enum ,
geoBackupEncryptionKeyStatus: enum ,
}
,
backup:
{
backupRetentionDays: integer ,
geoRedundantBackup: enum ,
earliestRestoreDate: string ,
}
,
network:
{
publicNetworkAccess: enum ,
delegatedSubnetResourceId: string ,
privateDnsZoneArmResourceId: string ,
}
,
highAvailability:
{
mode: enum ,
state: enum ,
standbyAvailabilityZone: string ,
}
,
maintenanceWindow:
{
customWindow: string ,
startHour: integer ,
startMinute: integer ,
dayOfWeek: integer ,
}
,
sourceServerResourceId: string ,
pointInTimeUTC: string ,
availabilityZone: string ,
replicationRole: enum ,
replicaCapacity: integer ,
replica:
{
role: enum ,
capacity: integer ,
replicationState: enum ,
promoteMode: enum ,
promoteOption: enum ,
}
,
createMode: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
cluster:
{
clusterSize: integer ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}