Servers interface

Interface representing a Servers.

Methods

beginCreate(string, string, Server, ServersCreateOptionalParams)

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

beginCreateAndWait(string, string, Server, ServersCreateOptionalParams)

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

beginDelete(string, string, ServersDeleteOptionalParams)

Deletes a server.

beginDeleteAndWait(string, string, ServersDeleteOptionalParams)

Deletes a server.

beginFailover(string, string, ServersFailoverOptionalParams)

Manual failover a server.

beginFailoverAndWait(string, string, ServersFailoverOptionalParams)

Manual failover a server.

beginRestart(string, string, ServerRestartParameter, ServersRestartOptionalParams)

Restarts a server.

beginRestartAndWait(string, string, ServerRestartParameter, ServersRestartOptionalParams)

Restarts a server.

beginStart(string, string, ServersStartOptionalParams)

Starts a server.

beginStartAndWait(string, string, ServersStartOptionalParams)

Starts a server.

beginStop(string, string, ServersStopOptionalParams)

Stops a server.

beginStopAndWait(string, string, ServersStopOptionalParams)

Stops a server.

beginUpdate(string, string, ServerForUpdate, ServersUpdateOptionalParams)

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

beginUpdateAndWait(string, string, ServerForUpdate, ServersUpdateOptionalParams)

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

get(string, string, ServersGetOptionalParams)

Gets information about a server.

list(ServersListOptionalParams)

List all the servers in a given subscription.

listByResourceGroup(string, ServersListByResourceGroupOptionalParams)

List all the servers in a given resource group.

Method Details

beginCreate(string, string, Server, ServersCreateOptionalParams)

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

function beginCreate(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOptionalParams): Promise<PollerLike<PollOperationState<Server>, Server>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
Server

The required parameters for creating or updating a server.

options
ServersCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Server>, Server>>

beginCreateAndWait(string, string, Server, ServersCreateOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
Server

The required parameters for creating or updating a server.

options
ServersCreateOptionalParams

The options parameters.

Returns

Promise<Server>

beginDelete(string, string, ServersDeleteOptionalParams)

Deletes a server.

function beginDelete(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ServersDeleteOptionalParams)

Deletes a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, ServersFailoverOptionalParams)

Manual failover a server.

function beginFailover(resourceGroupName: string, serverName: string, options?: ServersFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersFailoverOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginFailoverAndWait(string, string, ServersFailoverOptionalParams)

Manual failover a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersFailoverOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, ServerRestartParameter, ServersRestartOptionalParams)

Restarts a server.

function beginRestart(resourceGroupName: string, serverName: string, parameters: ServerRestartParameter, options?: ServersRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
ServerRestartParameter

The required parameters for restarting a server.

options
ServersRestartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginRestartAndWait(string, string, ServerRestartParameter, ServersRestartOptionalParams)

Restarts a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
ServerRestartParameter

The required parameters for restarting a server.

options
ServersRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ServersStartOptionalParams)

Starts a server.

function beginStart(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersStartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStartAndWait(string, string, ServersStartOptionalParams)

Starts a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, ServersStopOptionalParams)

Stops a server.

function beginStop(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersStopOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStopAndWait(string, string, ServersStopOptionalParams)

Stops a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ServerForUpdate, ServersUpdateOptionalParams)

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

function beginUpdate(resourceGroupName: string, serverName: string, parameters: ServerForUpdate, options?: ServersUpdateOptionalParams): Promise<PollerLike<PollOperationState<Server>, Server>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
ServerForUpdate

The required parameters for updating a server.

options
ServersUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Server>, Server>>

beginUpdateAndWait(string, string, ServerForUpdate, ServersUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

parameters
ServerForUpdate

The required parameters for updating a server.

options
ServersUpdateOptionalParams

The options parameters.

Returns

Promise<Server>

get(string, string, ServersGetOptionalParams)

Gets information about a server.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServersGetOptionalParams

The options parameters.

Returns

Promise<Server>

list(ServersListOptionalParams)

List all the servers in a given subscription.

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

Parameters

options
ServersListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ServersListByResourceGroupOptionalParams)

List all the servers in a given resource group.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
ServersListByResourceGroupOptionalParams

The options parameters.

Returns