FailoverGroups interface

Package:

@azure/arm-sql

Interface representing a FailoverGroups.

Methods

beginCreateOrUpdate(string, string, string, FailoverGroup, FailoverGroupsCreateOrUpdateOptionalParams)	Creates or updates a failover group.
beginCreateOrUpdateAndWait(string, string, string, FailoverGroup, FailoverGroupsCreateOrUpdateOptionalParams)	Creates or updates a failover group.
beginDelete(string, string, string, FailoverGroupsDeleteOptionalParams)	Deletes a failover group.
beginDeleteAndWait(string, string, string, FailoverGroupsDeleteOptionalParams)	Deletes a failover group.
beginFailover(string, string, string, FailoverGroupsFailoverOptionalParams)	Fails over from the current primary server to this server.
beginFailoverAndWait(string, string, string, FailoverGroupsFailoverOptionalParams)	Fails over from the current primary server to this server.
beginForceFailoverAllowDataLoss(string, string, string, FailoverGroupsForceFailoverAllowDataLossOptionalParams)	Fails over from the current primary server to this server. This operation might result in data loss.
beginForceFailoverAllowDataLossAndWait(string, string, string, FailoverGroupsForceFailoverAllowDataLossOptionalParams)	Fails over from the current primary server to this server. This operation might result in data loss.
beginUpdate(string, string, string, FailoverGroupUpdate, FailoverGroupsUpdateOptionalParams)	Updates a failover group.
beginUpdateAndWait(string, string, string, FailoverGroupUpdate, FailoverGroupsUpdateOptionalParams)	Updates a failover group.
get(string, string, string, FailoverGroupsGetOptionalParams)	Gets a failover group.
listByServer(string, string, FailoverGroupsListByServerOptionalParams)	Lists the failover groups in a server.

Method Details

beginCreateOrUpdate(string, string, string, FailoverGroup, FailoverGroupsCreateOrUpdateOptionalParams)

Creates or updates a failover group.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroup, options?: FailoverGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

parameters

FailoverGroup

The failover group parameters.

options

FailoverGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

beginCreateOrUpdateAndWait(string, string, string, FailoverGroup, FailoverGroupsCreateOrUpdateOptionalParams)

Creates or updates a failover group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroup, options?: FailoverGroupsCreateOrUpdateOptionalParams): Promise<FailoverGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

parameters

FailoverGroup

The failover group parameters.

options

FailoverGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FailoverGroup>

beginDelete(string, string, string, FailoverGroupsDeleteOptionalParams)

Deletes a failover group.

function beginDelete(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, FailoverGroupsDeleteOptionalParams)

Deletes a failover group.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, string, FailoverGroupsFailoverOptionalParams)

Fails over from the current primary server to this server.

function beginFailover(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsFailoverOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

beginFailoverAndWait(string, string, string, FailoverGroupsFailoverOptionalParams)

Fails over from the current primary server to this server.

function beginFailoverAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsFailoverOptionalParams): Promise<FailoverGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsFailoverOptionalParams

The options parameters.

Returns

Promise<FailoverGroup>

beginForceFailoverAllowDataLoss(string, string, string, FailoverGroupsForceFailoverAllowDataLossOptionalParams)

Fails over from the current primary server to this server. This operation might result in data loss.

function beginForceFailoverAllowDataLoss(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsForceFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

beginForceFailoverAllowDataLossAndWait(string, string, string, FailoverGroupsForceFailoverAllowDataLossOptionalParams)

Fails over from the current primary server to this server. This operation might result in data loss.

function beginForceFailoverAllowDataLossAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<FailoverGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsForceFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<FailoverGroup>

beginUpdate(string, string, string, FailoverGroupUpdate, FailoverGroupsUpdateOptionalParams)

Updates a failover group.

function beginUpdate(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroupUpdate, options?: FailoverGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

parameters

FailoverGroupUpdate

The failover group parameters.

options

FailoverGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>

beginUpdateAndWait(string, string, string, FailoverGroupUpdate, FailoverGroupsUpdateOptionalParams)

Updates a failover group.

function beginUpdateAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroupUpdate, options?: FailoverGroupsUpdateOptionalParams): Promise<FailoverGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

parameters

FailoverGroupUpdate

The failover group parameters.

options

FailoverGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<FailoverGroup>

get(string, string, string, FailoverGroupsGetOptionalParams)

Gets a failover group.

function get(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsGetOptionalParams): Promise<FailoverGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

failoverGroupName

string

The name of the failover group.

options

FailoverGroupsGetOptionalParams

The options parameters.

Returns

Promise<FailoverGroup>

listByServer(string, string, FailoverGroupsListByServerOptionalParams)

Lists the failover groups in a server.

function listByServer(resourceGroupName: string, serverName: string, options?: FailoverGroupsListByServerOptionalParams): PagedAsyncIterableIterator<FailoverGroup, FailoverGroup[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server containing the failover group.

options

FailoverGroupsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FailoverGroup, FailoverGroup[], PageSettings>