ServerForUpdate interface

Represents a server to be updated.

Properties

administratorLogin

The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login.

administratorLoginPassword

The password of the administrator login. This value contains a credential. Consider obscuring before showing to users

authConfig

AuthConfig properties of a server.

backup

Backup properties of a server.

createMode

The mode to update a new PostgreSQL server.

dataEncryption

Data encryption properties of a server.

highAvailability

High availability properties of a server.

identity

Describes the identity of the application.

maintenanceWindow

Maintenance window properties of a server.

network

Network properties of a server. These are required to be passed only in case if server is a private access server.

replica

Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.

replicationRole

Replication role of the server

sku

The SKU (pricing tier) of the server.

storage

Storage properties of a server.

tags

Application-specific metadata in the form of key-value pairs.

version

PostgreSQL Server version. Version 16 is currently not supported for MVU.

Property Details

administratorLogin

The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login.

administratorLogin?: string

Property Value

string

administratorLoginPassword

The password of the administrator login. This value contains a credential. Consider obscuring before showing to users

administratorLoginPassword?: string

Property Value

string

authConfig

AuthConfig properties of a server.

authConfig?: AuthConfig

Property Value

backup

Backup properties of a server.

backup?: Backup

Property Value

createMode

The mode to update a new PostgreSQL server.

createMode?: string

Property Value

string

dataEncryption

Data encryption properties of a server.

dataEncryption?: DataEncryption

Property Value

highAvailability

High availability properties of a server.

highAvailability?: HighAvailability

Property Value

identity

Describes the identity of the application.

identity?: UserAssignedIdentity

Property Value

maintenanceWindow

Maintenance window properties of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

network

Network properties of a server. These are required to be passed only in case if server is a private access server.

network?: Network

Property Value

replica

Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.

replica?: Replica

Property Value

replicationRole

Replication role of the server

replicationRole?: string

Property Value

string

sku

The SKU (pricing tier) of the server.

sku?: Sku

Property Value

Sku

storage

Storage properties of a server.

storage?: Storage

Property Value

tags

Application-specific metadata in the form of key-value pairs.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

version

PostgreSQL Server version. Version 16 is currently not supported for MVU.

version?: string

Property Value

string