Interface Server
-
public interface ServerAn immutable client-side representation of Server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceServer.DefinitionThe entirety of the Server definition.static interfaceServer.DefinitionStagesThe Server definition stages.static interfaceServer.UpdateThe template for Server update.static interfaceServer.UpdateStagesThe Server update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringadministratorLogin()Gets the administratorLogin property: The administrator's login name of a server.StringbyokEnforcement()Gets the byokEnforcement property: Status showing whether the server data encryption is enabled with customer-managed keys.OffsetDateTimeearliestRestoreDate()Gets the earliestRestoreDate property: Earliest restore point creation time (ISO8601 format).StringfullyQualifiedDomainName()Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.Stringid()Gets the id property: Fully qualified resource Id for the resource.ResourceIdentityidentity()Gets the identity property: The Azure Active Directory identity of the server.InfrastructureEncryptioninfrastructureEncryption()Gets the infrastructureEncryption property: Status showing whether the server enabled infrastructure encryption.ServerInnerinnerModel()Gets the inner com.azure.resourcemanager.mysql.fluent.models.ServerInner object.Stringlocation()Gets the location property: The geo-location where the resource lives.StringmasterServerId()Gets the masterServerId property: The master server id of a replica server.MinimalTlsVersionEnumminimalTlsVersion()Gets the minimalTlsVersion property: Enforce a minimal Tls version for the server.Stringname()Gets the name property: The name of the resource.List<ServerPrivateEndpointConnection>privateEndpointConnections()Gets the privateEndpointConnections property: List of private endpoint connections on a server.PublicNetworkAccessEnumpublicNetworkAccess()Gets the publicNetworkAccess property: Whether or not public network access is allowed for this server.Serverrefresh()Refreshes the resource to sync with Azure.Serverrefresh(com.azure.core.util.Context context)Refreshes the resource to sync with Azure.com.azure.core.management.Regionregion()Gets the region of the resource.StringregionName()Gets the name of the resource region.IntegerreplicaCapacity()Gets the replicaCapacity property: The maximum number of replicas that a master server can have.StringreplicationRole()Gets the replicationRole property: The replication role of the server.voidrestart()Restarts a server.voidrestart(com.azure.core.util.Context context)Restarts a server.Skusku()Gets the sku property: The SKU (pricing tier) of the server.SslEnforcementEnumsslEnforcement()Gets the sslEnforcement property: Enable ssl enforcement or not when connect to server.voidstart()Starts a stopped server.voidstart(com.azure.core.util.Context context)Starts a stopped server.voidstop()Stops a running server.voidstop(com.azure.core.util.Context context)Stops a running server.StorageProfilestorageProfile()Gets the storageProfile property: Storage profile of a server.Map<String,String>tags()Gets the tags property: Resource tags.Stringtype()Gets the type property: The type of the resource.Server.Updateupdate()Begins update for the Server resource.voidupgrade(ServerUpgradeParameters parameters)Upgrade server version.voidupgrade(ServerUpgradeParameters parameters, com.azure.core.util.Context context)Upgrade server version.ServerStateuserVisibleState()Gets the userVisibleState property: A state of a server that is visible to user.ServerVersionversion()Gets the version property: Server version.
-
-
-
Method Detail
-
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.
-
identity
ResourceIdentity identity()
Gets the identity property: The Azure Active Directory identity of the server.- Returns:
- the identity value.
-
sku
Sku sku()
Gets the sku property: The SKU (pricing tier) of the server.- Returns:
- the sku 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.
-
version
ServerVersion version()
Gets the version property: Server version.- Returns:
- the version value.
-
sslEnforcement
SslEnforcementEnum sslEnforcement()
Gets the sslEnforcement property: Enable ssl enforcement or not when connect to server.- Returns:
- the sslEnforcement value.
-
minimalTlsVersion
MinimalTlsVersionEnum minimalTlsVersion()
Gets the minimalTlsVersion property: Enforce a minimal Tls version for the server.- Returns:
- the minimalTlsVersion value.
-
byokEnforcement
String byokEnforcement()
Gets the byokEnforcement property: Status showing whether the server data encryption is enabled with customer-managed keys.- Returns:
- the byokEnforcement value.
-
infrastructureEncryption
InfrastructureEncryption infrastructureEncryption()
Gets the infrastructureEncryption property: Status showing whether the server enabled infrastructure encryption.- Returns:
- the infrastructureEncryption value.
-
userVisibleState
ServerState userVisibleState()
Gets the userVisibleState property: A state of a server that is visible to user.- Returns:
- the userVisibleState value.
-
fullyQualifiedDomainName
String fullyQualifiedDomainName()
Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.- Returns:
- the fullyQualifiedDomainName value.
-
earliestRestoreDate
OffsetDateTime earliestRestoreDate()
Gets the earliestRestoreDate property: Earliest restore point creation time (ISO8601 format).- Returns:
- the earliestRestoreDate value.
-
storageProfile
StorageProfile storageProfile()
Gets the storageProfile property: Storage profile of a server.- Returns:
- the storageProfile value.
-
replicationRole
String replicationRole()
Gets the replicationRole property: The replication role of the server.- Returns:
- the replicationRole value.
-
masterServerId
String masterServerId()
Gets the masterServerId property: The master server id of a replica server.- Returns:
- the masterServerId value.
-
replicaCapacity
Integer replicaCapacity()
Gets the replicaCapacity property: The maximum number of replicas that a master server can have.- Returns:
- the replicaCapacity value.
-
publicNetworkAccess
PublicNetworkAccessEnum publicNetworkAccess()
Gets the publicNetworkAccess property: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.- Returns:
- the publicNetworkAccess value.
-
privateEndpointConnections
List<ServerPrivateEndpointConnection> privateEndpointConnections()
Gets the privateEndpointConnections property: List of private endpoint connections on a server.- Returns:
- the privateEndpointConnections 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.
-
innerModel
ServerInner innerModel()
Gets the inner com.azure.resourcemanager.mysql.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
Server refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-
restart
void restart()
Restarts 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.
-
restart
void restart(com.azure.core.util.Context context)
Restarts 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.
-
start
void start()
Starts a stopped 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 stopped 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 running 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 running 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.
-
upgrade
void upgrade(ServerUpgradeParameters parameters)
Upgrade server version.- Parameters:
parameters- The required parameters for updating 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.
-
upgrade
void upgrade(ServerUpgradeParameters parameters, com.azure.core.util.Context context)
Upgrade server version.- Parameters:
parameters- The required parameters for updating 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.
-
-