Server interface

Package:

@azure/arm-mysql-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 password of the administrator login (required for server creation). This value contains a credential. Consider obscuring before showing to users
availabilityZone	availability Zone information of the server.
backup	Backup related properties of a server.
createMode	The mode to create a new MySQL server.
dataEncryption	The Data Encryption for CMK.
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 related properties of a server.
identity	The cmk identity for the server.
importSourceProperties	Source properties for import from storage.
maintenanceWindow	Maintenance window of a server.
network	Network related properties of a server.
privateEndpointConnections	PrivateEndpointConnections related properties of a server. NOTE: This property will not be serialized. It can only be populated by the server.
replicaCapacity	The maximum number of replicas that a primary server can have. NOTE: This property will not be serialized. It can only be populated by the server.
replicationRole	The replication role.
restorePointInTime	Restore point creation time (ISO8601 format), specifying the time to restore from.
sku	The SKU (pricing tier) of the server.
sourceServerResourceId	The source MySQL server id.
state	The state of a server. NOTE: This property will not be serialized. It can only be populated by the server.
storage	Storage related properties of a server.
version	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 password of the administrator login (required for server creation). This value contains a credential. Consider obscuring before showing to users

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

dataEncryption

The Data Encryption for CMK.

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

highAvailability?: HighAvailability

Property Value

HighAvailability

identity

The cmk identity for the server.

identity?: MySQLServerIdentity

Property Value

MySQLServerIdentity

importSourceProperties

Source properties for import from storage.

importSourceProperties?: ImportSourceProperties

Property Value

ImportSourceProperties

maintenanceWindow

Maintenance window of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

network

Network related properties of a server.

network?: Network

Property Value

Network

privateEndpointConnections

PrivateEndpointConnections related properties of a server. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

replicaCapacity

The maximum number of replicas that a primary server can have. NOTE: This property will not be serialized. It can only be populated by the server.

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

sku

The SKU (pricing tier) of the server.

sku?: MySQLServerSku

Property Value

MySQLServerSku

sourceServerResourceId

The source MySQL server id.

sourceServerResourceId?: string

Property Value

string

state

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

state?: string

Property Value

string

storage

Storage related properties of a server.

storage?: Storage

Property Value

Storage

version

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