Share via


ServerForPatch interface

Represents a server to be updated.

Properties

administratorLogin

Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.

administratorLoginPassword

Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. This value contains a credential. Consider obscuring before showing to users

authConfig

Authentication configuration properties of a server.

availabilityZone

Availability zone of a server.

backup

Backup properties of a server.

cluster

Cluster properties of a server.

createMode

Update mode of an existing 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. Only required if you want your server to be integrated into a virtual network provided by customer.

replica

Read replica properties of a server. Required only in case that you want to promote a server.

replicationRole

Role of the server in a replication set.

sku

Compute tier and size of a server.

storage

Storage properties of a server.

tags

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

version

Major version of PostgreSQL database engine.

Property Details

administratorLogin

Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.

administratorLogin?: string

Property Value

string

administratorLoginPassword

Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. This value contains a credential. Consider obscuring before showing to users

administratorLoginPassword?: string

Property Value

string

authConfig

Authentication configuration properties of a server.

authConfig?: AuthConfigForPatch

Property Value

availabilityZone

Availability zone of a server.

availabilityZone?: string

Property Value

string

backup

Backup properties of a server.

backup?: BackupForPatch

Property Value

cluster

Cluster properties of a server.

cluster?: Cluster

Property Value

createMode

Update mode of an existing 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?: HighAvailabilityForPatch

Property Value

identity

Describes the identity of the application.

identity?: UserAssignedIdentity

Property Value

maintenanceWindow

Maintenance window properties of a server.

maintenanceWindow?: MaintenanceWindowForPatch

Property Value

network

Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.

network?: Network

Property Value

replica

Read replica properties of a server. Required only in case that you want to promote a server.

replica?: Replica

Property Value

replicationRole

Role of the server in a replication set.

replicationRole?: string

Property Value

string

sku

Compute tier and size of a server.

sku?: SkuForPatch

Property Value

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

Major version of PostgreSQL database engine.

version?: string

Property Value

string