Share via


Server Class

Represents a server.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Server(*, location: str, tags: dict[str, str] | None = None, identity: _models.Identity | None = None, sku: _models.Sku | None = None, administrator_login: str | None = None, administrator_login_password: str | None = None, version: str | _models.ServerVersion | None = None, availability_zone: str | None = None, create_mode: str | _models.CreateMode | None = None, source_server_resource_id: str | None = None, restore_point_in_time: datetime | None = None, replication_role: str | _models.ReplicationRole | None = None, data_encryption: _models.DataEncryption | None = None, storage: _models.Storage | None = None, backup: _models.Backup | None = None, high_availability: _models.HighAvailability | None = None, network: _models.Network | None = None, maintenance_window: _models.MaintenanceWindow | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

Default value: None
location
str

The geo-location where the resource lives. Required.

identity

The cmk identity for the server.

Default value: None
sku
Sku

The SKU (pricing tier) of the server.

Default value: None
administrator_login
str

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

Default value: None
administrator_login_password
str

The password of the administrator login (required for server creation).

Default value: None
version

Server version. Known values are: "5.7" and "8.0.21".

Default value: None
availability_zone
str

availability Zone information of the server.

Default value: None
create_mode

The mode to create a new MySQL server. Known values are: "Default", "PointInTimeRestore", "Replica", and "GeoRestore".

Default value: None
source_server_resource_id
str

The source MySQL server id.

Default value: None
restore_point_in_time

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

Default value: None
replication_role

The replication role. Known values are: "None", "Source", and "Replica".

Default value: None
data_encryption

The Data Encryption for CMK.

Default value: None
storage

Storage related properties of a server.

Default value: None
backup

Backup related properties of a server.

Default value: None
high_availability

High availability related properties of a server.

Default value: None
network

Network related properties of a server.

Default value: None
maintenance_window

Maintenance window of a server.

Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name
str

The name of the resource.

type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

tags

Resource tags.

location
str

The geo-location where the resource lives. Required.

identity

The cmk identity for the server.

sku
Sku

The SKU (pricing tier) of the server.

system_data

The system metadata relating to this resource.

administrator_login
str

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

administrator_login_password
str

The password of the administrator login (required for server creation).

version

Server version. Known values are: "5.7" and "8.0.21".

availability_zone
str

availability Zone information of the server.

create_mode

The mode to create a new MySQL server. Known values are: "Default", "PointInTimeRestore", "Replica", and "GeoRestore".

source_server_resource_id
str

The source MySQL server id.

restore_point_in_time

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

replication_role

The replication role. Known values are: "None", "Source", and "Replica".

replica_capacity
int

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

data_encryption

The Data Encryption for CMK.

state

The state of a server. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", and "Updating".

fully_qualified_domain_name
str

The fully qualified domain name of a server.

storage

Storage related properties of a server.

backup

Backup related properties of a server.

high_availability

High availability related properties of a server.

network

Network related properties of a server.

maintenance_window

Maintenance window of a server.