Share via

Server interface

  • Reference
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.
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.
maintenanceWindow

Maintenance window of a server.
network

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

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
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

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

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

maintenanceWindow

Maintenance window of a server.

maintenanceWindow?: MaintenanceWindow

Property Value

MaintenanceWindow

network

Network related properties of a server.

network?: Network

Property Value

Network

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?: Sku

Property Value

Sku

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_2

Property Value

Storage

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

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