Server interface

Package:

@azure/arm-postgresql-flexible

Represents a server.

Extends

TrackedResource

Properties

administratorLogin	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
administratorLoginPassword	The administrator login password (required for server creation). This value contains a credential. Consider obscuring before showing to users
authConfig	AuthConfig properties of a server.
availabilityZone	availability zone information of the server.
backup	Backup properties of a server.
createMode	The mode to create a new PostgreSQL server.
dataEncryption	Data encryption properties of a server.
fullyQualifiedDomainName	The fully qualified domain name of a server. NOTE: This property will not be serialized. It can only be populated by the server.
highAvailability	High availability properties of a server.
identity	Describes the identity of the application.
maintenanceWindow	Maintenance window properties of a server.
minorVersion	The minor version of the server. NOTE: This property will not be serialized. It can only be populated by the server.
network	Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
pointInTimeUTC	Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.
privateEndpointConnections	List of private endpoint connections associated with the specified resource. NOTE: This property will not be serialized. It can only be populated by the server.
replica	Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
replicaCapacity	Replicas allowed for a server. NOTE: This property will not be serialized. It can only be populated by the server.
replicationRole	Replication role of the server
sku	The SKU (pricing tier) of the server.
sourceServerResourceId	The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
state	A state of a server that is visible to user. NOTE: This property will not be serialized. It can only be populated by the server.
storage	Storage properties of a server.
version	PostgreSQL Server version.

Inherited Properties

id	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.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	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.

Property Details

administratorLogin

The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).

administratorLogin?: string

Property Value

string

administratorLoginPassword

The administrator login password (required for server creation). 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

AuthConfig

availabilityZone

availability zone information of the server.

availabilityZone?: string

Property Value

string

backup

Backup properties of a server.

backup?: Backup

Property Value

Backup

createMode

The mode to create a new PostgreSQL server.

createMode?: string

Property Value

string

dataEncryption

Data encryption properties of a server.

dataEncryption?: DataEncryption

Property Value

DataEncryption

fullyQualifiedDomainName

The 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

string

highAvailability

High availability properties of a server.

highAvailability?: HighAvailability

Property Value

HighAvailability

identity

Describes the identity of the application.

identity?: UserAssignedIdentity

Property Value

UserAssignedIdentity

maintenanceWindow

Maintenance window properties of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

minorVersion

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

minorVersion?: string

Property Value

string

network

Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.

network?: Network

Property Value

Network

pointInTimeUTC

Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.

pointInTimeUTC?: Date

Property Value

Date

privateEndpointConnections

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

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

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

Replica

replicaCapacity

Replicas allowed for a server. NOTE: This property will not be serialized. It can only be populated by the server.

replicaCapacity?: number

Property Value

number

replicationRole

Replication role of the server

replicationRole?: string

Property Value

string

sku

The SKU (pricing tier) of the server.

sku?: Sku

Property Value

Sku

sourceServerResourceId

The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server

sourceServerResourceId?: string

Property Value

string

state

A state of a server that is visible to user. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

storage

Storage properties of a server.

storage?: Storage

Property Value

Storage

version

PostgreSQL Server version.

version?: string

Property Value

string

Inherited Property Details

id

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

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

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

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

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

string

Inherited From TrackedResource.type