ServerProperties interface

Package:
@azure/arm-postgresql-flexible

Properties of a server.

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.
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

Creation mode of a new server.
dataEncryption

Data encryption properties of a server.
fullyQualifiedDomainName

Fully qualified domain name of a server.
highAvailability

High availability properties of a server.
maintenanceWindow

Maintenance window properties of a server.
minorVersion

Minor version of PostgreSQL database engine.
network

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

Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.
privateEndpointConnections

List of private endpoint connections associated with the specified server.
replica

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

Maximum number of read replicas allowed for a server.
replicationRole

Role of the server in a replication set.
sourceServerResourceId

Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica.
state

Possible states of a server.
storage

Storage properties of a server.
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.

administratorLoginPassword?: string

Property Value

string

authConfig

Authentication configuration properties of a server.

authConfig?: AuthConfig

Property Value

AuthConfig

availabilityZone

Availability zone of a server.

availabilityZone?: string

Property Value

string

backup

Backup properties of a server.

backup?: Backup

Property Value

Backup

cluster

Cluster properties of a server.

cluster?: Cluster

Property Value

Cluster

createMode

Creation mode of a new server.

createMode?: string

Property Value

string

dataEncryption

Data encryption properties of a server.

dataEncryption?: DataEncryption

Property Value

DataEncryption

fullyQualifiedDomainName

Fully qualified domain name of a server.

fullyQualifiedDomainName?: string

Property Value

string

highAvailability

High availability properties of a server.

highAvailability?: HighAvailability

Property Value

HighAvailability

maintenanceWindow

Maintenance window properties of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

minorVersion

Minor version of PostgreSQL database engine.

minorVersion?: string

Property Value

string

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

Network

pointInTimeUTC

Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.

pointInTimeUTC?: Date

Property Value

Date

privateEndpointConnections

List of private endpoint connections associated with the specified server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

replica

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

replica?: Replica

Property Value

Replica

replicaCapacity

Maximum number of read replicas allowed for a server.

replicaCapacity?: number

Property Value

number

replicationRole

Role of the server in a replication set.

replicationRole?: string

Property Value

string

sourceServerResourceId

Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica.

sourceServerResourceId?: string

Property Value

string

state

Possible states of a server.

state?: string

Property Value

string

storage

Storage properties of a server.

storage?: Storage

Property Value

Storage

version

Major version of PostgreSQL database engine.

version?: string

Property Value

string