Server interface

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

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

Authentication configuration properties of a server.

authConfig?: AuthConfig

Property Value

Availability zone of a server.

availabilityZone?: string

Property Value

Backup properties of a server.

backup?: Backup

Property Value

Cluster properties of a server.

cluster?: Cluster

Property Value

Creation mode of a new server.

createMode?: string

Property Value

Data encryption properties of a server.

dataEncryption?: DataEncryption

Property Value

Fully qualified domain name of a server. NOTE: This property will not be serialized. It can only be populated by the server.

fullyQualifiedDomainName?: string

Property Value

High availability properties of a server.

highAvailability?: HighAvailability

Property Value

User assigned managed identities assigned to the server.

identity?: UserAssignedIdentity

Property Value

Maintenance window properties of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

Minor version of PostgreSQL database engine. NOTE: This property will not be serialized. It can only be populated by the server.

minorVersion?: string

Property Value

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

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

List of private endpoint connections associated with the specified server. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

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

replica?: Replica

Property Value

Maximum number of read replicas allowed for a server. NOTE: This property will not be serialized. It can only be populated by the server.

replicaCapacity?: number

Property Value

Role of the server in a replication set.

replicationRole?: string

Property Value

Compute tier and size of a server.

sku?: Sku

Property Value

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

Possible states of a server. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

Storage properties of a server.

storage?: Storage

Property Value

Major version of PostgreSQL database engine.

version?: string

Property Value

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

Inherited From TrackedResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

Resource tags.

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

Property Value

Inherited From TrackedResource.tags

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

Inherited From TrackedResource.type