ServersOperations interface

Package:

@azure/arm-mysql-flexible

Interface representing a Servers operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginDetachVNet
beginDetachVNetAndWait
beginFailover
beginFailoverAndWait
beginResetGtid
beginResetGtidAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
create	Creates a new server or updates an existing server. The update action will overwrite the existing server.
delete	Deletes a server.
detachVNet	Detach VNet on a server.
failover	Manual failover a server.
get	Gets information about a server.
list	List all the servers in a given subscription.
listByResourceGroup	List all the servers in a given resource group.
resetGtid	Resets GTID on a server.
restart	Restarts a server.
start	Starts a server.
stop	Stops a server.
update	Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
validateEstimateHighAvailability	Validate a deployment of high availability.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => Promise<Server>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<void>

beginDetachVNet

Warning

This API is now deprecated.

use detachVNet instead

beginDetachVNet: (resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

beginDetachVNetAndWait

Warning

This API is now deprecated.

use detachVNet instead

beginDetachVNetAndWait: (resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => Promise<Server>

beginFailover

Warning

This API is now deprecated.

use failover instead

beginFailover: (resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

beginFailoverAndWait: (resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => Promise<void>

beginResetGtid

Warning

This API is now deprecated.

use resetGtid instead

beginResetGtid: (resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginResetGtidAndWait

Warning

This API is now deprecated.

use resetGtid instead

beginResetGtidAndWait: (resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => Promise<void>

beginRestart

Warning

This API is now deprecated.

use restart instead

beginRestart: (resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

beginRestartAndWait: (resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<void>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => Promise<Server>

create

Creates a new server or updates an existing server. The update action will overwrite the existing server.

create: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => PollerLike<OperationState<Server>, Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams) => PollerLike<OperationState<Server>, Server>

delete

Deletes a server.

delete: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

detachVNet

Detach VNet on a server.

detachVNet: (resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => PollerLike<OperationState<Server>, Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerDetachVNetParameter, options?: ServersDetachVNetOptionalParams) => PollerLike<OperationState<Server>, Server>

failover

Manual failover a server.

failover: (resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about a server.

get: (resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams) => Promise<Server>

list

List all the servers in a given subscription.

list: (options?: ServersListOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

Property Value

(options?: ServersListOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

listByResourceGroup

List all the servers in a given resource group.

listByResourceGroup: (resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

Property Value

(resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

resetGtid

Resets GTID on a server.

resetGtid: (resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerGtidSetParameter, options?: ServersResetGtidOptionalParams) => PollerLike<OperationState<void>, void>

restart

Restarts a server.

restart: (resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts a server.

start: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Stops a server.

stop: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

update: (resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>

validateEstimateHighAvailability

Validate a deployment of high availability.

validateEstimateHighAvailability: (resourceGroupName: string, serverName: string, parameters: HighAvailabilityValidationEstimation, options?: ServersValidateEstimateHighAvailabilityOptionalParams) => Promise<HighAvailabilityValidationEstimation>

Property Value

(resourceGroupName: string, serverName: string, parameters: HighAvailabilityValidationEstimation, options?: ServersValidateEstimateHighAvailabilityOptionalParams) => Promise<HighAvailabilityValidationEstimation>