Share via

Server interface

Package:
@azure/arm-postgresql

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

Status showing whether the server data encryption is enabled with customer-managed keys. NOTE: This property will not be serialized. It can only be populated by the server.
earliestRestoreDate

Earliest restore point creation time (ISO8601 format)
fullyQualifiedDomainName

The fully qualified domain name of a server.
identity

The Azure Active Directory identity of the server.
infrastructureEncryption

Status showing whether the server enabled infrastructure encryption.
masterServerId

The master server id of a replica server.
minimalTlsVersion

Enforce a minimal Tls version for the server.
privateEndpointConnections

List of private endpoint connections on a server NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
replicaCapacity

The maximum number of replicas that a master server can have.
replicationRole

The replication role of the server.
sku

The SKU (pricing tier) of the server.
sslEnforcement

Enable ssl enforcement or not when connect to server.
storageProfile

Storage profile of a server.
userVisibleState

A state of a server that is visible to user.
version

Server version.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /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.
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

byokEnforcement

Status showing whether the server data encryption is enabled with customer-managed keys. NOTE: This property will not be serialized. It can only be populated by the server.

byokEnforcement?: string

Property Value

string

earliestRestoreDate

Earliest restore point creation time (ISO8601 format)

earliestRestoreDate?: Date

Property Value

Date

fullyQualifiedDomainName

The fully qualified domain name of a server.

fullyQualifiedDomainName?: string

Property Value

string

identity

The Azure Active Directory identity of the server.

identity?: ResourceIdentity

Property Value

ResourceIdentity

infrastructureEncryption

Status showing whether the server enabled infrastructure encryption.

infrastructureEncryption?: string

Property Value

string

masterServerId

The master server id of a replica server.

masterServerId?: string

Property Value

string

minimalTlsVersion

Enforce a minimal Tls version for the server.

minimalTlsVersion?: string

Property Value

string

privateEndpointConnections

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

privateEndpointConnections?: ServerPrivateEndpointConnection[]

Property Value

ServerPrivateEndpointConnection[]

publicNetworkAccess

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

publicNetworkAccess?: string

Property Value

string

replicaCapacity

The maximum number of replicas that a master server can have.

replicaCapacity?: number

Property Value

number

replicationRole

The replication role of the server.

replicationRole?: string

Property Value

string

sku

The SKU (pricing tier) of the server.

sku?: Sku

Property Value

Sku

sslEnforcement

Enable ssl enforcement or not when connect to server.

sslEnforcement?: SslEnforcementEnum

Property Value

SslEnforcementEnum

storageProfile

Storage profile of a server.

storageProfile?: StorageProfile

Property Value

StorageProfile

userVisibleState

A state of a server that is visible to user.

userVisibleState?: string

Property Value

string

version

Server version.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /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

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