Interface Server
public interface Server
An immutable client-side representation of Server.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the Server definition.static interface
The Server definition stages.static interface
The template for Server update.static interface
The Server update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the administratorLogin property: The administrator's login name of a server.Gets the administratorLoginPassword property: The password of the administrator login (required for server creation).Gets the availabilityZone property: availability Zone information of the server.backup()
Gets the backup property: Backup related properties of a server.Gets the createMode property: The mode to create a new MySQL server.Gets the dataEncryption property: The Data Encryption for CMK.void
failover()
Manual failover a server.void
failover
(com.azure.core.util.Context context) Manual failover a server.Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.Gets the highAvailability property: High availability related properties of a server.id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: The cmk identity for the server.Gets the inner com.azure.resourcemanager.mysqlflexibleserver.fluent.models.ServerInner object.location()
Gets the location property: The geo-location where the resource lives.Gets the maintenanceWindow property: Maintenance window of a server.name()
Gets the name property: The name of the resource.network()
Gets the network property: Network related properties of a server.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the replicaCapacity property: The maximum number of replicas that a primary server can have.Gets the replicationRole property: The replication role.Gets the name of the resource group.void
restart
(ServerRestartParameter parameters) Restarts a server.void
restart
(ServerRestartParameter parameters, com.azure.core.util.Context context) Restarts a server.Gets the restorePointInTime property: Restore point creation time (ISO8601 format), specifying the time to restore from.sku()
Gets the sku property: The SKU (pricing tier) of the server.Gets the sourceServerResourceId property: The source MySQL server id.void
start()
Starts a server.void
start
(com.azure.core.util.Context context) Starts a server.state()
Gets the state property: The state of a server.void
stop()
Stops a server.void
stop
(com.azure.core.util.Context context) Stops a server.storage()
Gets the storage property: Storage related properties of a server.com.azure.core.management.SystemData
Gets the systemData property: The system metadata relating to this resource.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the Server resource.version()
Gets the version property: Server version.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
identity
Identity identity()Gets the identity property: The cmk identity for the server.- Returns:
- the identity value.
-
sku
Sku sku()Gets the sku property: The SKU (pricing tier) of the server.- Returns:
- the sku value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: The system metadata relating to this resource.- Returns:
- the systemData value.
-
administratorLogin
String administratorLogin()Gets the administratorLogin property: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).- Returns:
- the administratorLogin value.
-
administratorLoginPassword
String administratorLoginPassword()Gets the administratorLoginPassword property: The password of the administrator login (required for server creation).- Returns:
- the administratorLoginPassword value.
-
version
ServerVersion version()Gets the version property: Server version.- Returns:
- the version value.
-
availabilityZone
String availabilityZone()Gets the availabilityZone property: availability Zone information of the server.- Returns:
- the availabilityZone value.
-
createMode
CreateMode createMode()Gets the createMode property: The mode to create a new MySQL server.- Returns:
- the createMode value.
-
sourceServerResourceId
String sourceServerResourceId()Gets the sourceServerResourceId property: The source MySQL server id.- Returns:
- the sourceServerResourceId value.
-
restorePointInTime
OffsetDateTime restorePointInTime()Gets the restorePointInTime property: Restore point creation time (ISO8601 format), specifying the time to restore from.- Returns:
- the restorePointInTime value.
-
replicationRole
ReplicationRole replicationRole()Gets the replicationRole property: The replication role.- Returns:
- the replicationRole value.
-
replicaCapacity
Integer replicaCapacity()Gets the replicaCapacity property: The maximum number of replicas that a primary server can have.- Returns:
- the replicaCapacity value.
-
dataEncryption
DataEncryption dataEncryption()Gets the dataEncryption property: The Data Encryption for CMK.- Returns:
- the dataEncryption value.
-
state
ServerState state()Gets the state property: The state of a server.- Returns:
- the state value.
-
fullyQualifiedDomainName
String fullyQualifiedDomainName()Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.- Returns:
- the fullyQualifiedDomainName value.
-
storage
Storage storage()Gets the storage property: Storage related properties of a server.- Returns:
- the storage value.
-
backup
Backup backup()Gets the backup property: Backup related properties of a server.- Returns:
- the backup value.
-
highAvailability
HighAvailability highAvailability()Gets the highAvailability property: High availability related properties of a server.- Returns:
- the highAvailability value.
-
network
Network network()Gets the network property: Network related properties of a server.- Returns:
- the network value.
-
maintenanceWindow
MaintenanceWindow maintenanceWindow()Gets the maintenanceWindow property: Maintenance window of a server.- Returns:
- the maintenanceWindow value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
ServerInner innerModel()Gets the inner com.azure.resourcemanager.mysqlflexibleserver.fluent.models.ServerInner object.- Returns:
- the inner object.
-
update
Server.Update update()Begins update for the Server resource.- Returns:
- the stage of resource update.
-
refresh
Server refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
failover
void failover()Manual failover a server.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
failover
void failover(com.azure.core.util.Context context) Manual failover a server.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
restart
Restarts a server.- Parameters:
parameters
- The required parameters for restarting a server.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
restart
Restarts a server.- Parameters:
parameters
- The required parameters for restarting a server.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
start
void start()Starts a server.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
start
void start(com.azure.core.util.Context context) Starts a server.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
stop
void stop()Stops a server.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
stop
void stop(com.azure.core.util.Context context) Stops a server.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-