ServerProperties interface

Package:

@azure/arm-mysql-flexible

The properties of a server.

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 password of the administrator login (required for server creation).
availabilityZone	availability Zone information of the server.
backup	Backup related properties of a server.
createMode	The mode to create a new MySQL server.
databasePort	The server database port. Can only be specified when the server is being created.
dataEncryption	The Data Encryption for CMK.
fullVersion	Major version and actual engine version
fullyQualifiedDomainName	The fully qualified domain name of a server.
highAvailability	High availability related properties of a server.
importSourceProperties	Source properties for import from storage.
lowerCaseTableNames	The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2.
maintenancePolicy	Maintenance policy of a server.
maintenanceWindow	Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.
network	Network related properties of a server.
privateEndpointConnections	PrivateEndpointConnections related properties of a server.
replicaCapacity	The maximum number of replicas that a primary server can have.
replicationRole	The replication role.
restorePointInTime	Restore point creation time (ISO8601 format), specifying the time to restore from.
sourceServerResourceId	The source MySQL server id.
state	The state of a server.
storage	Storage related properties of a server.
version	Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7

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

administratorLoginPassword?: string

Property Value

string

availabilityZone

availability Zone information of the server.

availabilityZone?: string

Property Value

string

backup

Backup related properties of a server.

backup?: Backup

Property Value

Backup

createMode

The mode to create a new MySQL server.

createMode?: string

Property Value

string

databasePort

The server database port. Can only be specified when the server is being created.

databasePort?: number

Property Value

number

dataEncryption

The Data Encryption for CMK.

dataEncryption?: DataEncryption

Property Value

DataEncryption

fullVersion

Major version and actual engine version

fullVersion?: string

Property Value

string

fullyQualifiedDomainName

The fully qualified domain name of a server.

fullyQualifiedDomainName?: string

Property Value

string

highAvailability

High availability related properties of a server.

highAvailability?: HighAvailability

Property Value

HighAvailability

importSourceProperties

Source properties for import from storage.

importSourceProperties?: ImportSourceProperties

Property Value

ImportSourceProperties

lowerCaseTableNames

The mysql parameter lower_case_table_names. Can only be specified when the server is being created. Allowed values 1 or 2.

lowerCaseTableNames?: number

Property Value

number

maintenancePolicy

Maintenance policy of a server.

maintenancePolicy?: MaintenancePolicy

Property Value

MaintenancePolicy

maintenanceWindow

Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

network

Network related properties of a server.

network?: Network

Property Value

Network

privateEndpointConnections

PrivateEndpointConnections related properties of a server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

replicaCapacity

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

replicaCapacity?: number

Property Value

number

replicationRole

The replication role.

replicationRole?: string

Property Value

string

restorePointInTime

Restore point creation time (ISO8601 format), specifying the time to restore from.

restorePointInTime?: Date

Property Value

Date

sourceServerResourceId

The source MySQL server id.

sourceServerResourceId?: string

Property Value

string

state

The state of a server.

state?: string

Property Value

string

storage

Storage related properties of a server.

storage?: Storage

Property Value

Storage

version

Major version of MySQL. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7

version?: string

Property Value

string