InstanceFailoverGroups interface

Package:

@azure/arm-sql

Interface representing a InstanceFailoverGroups.

Methods

beginCreateOrUpdate(string, string, string, InstanceFailoverGroup, InstanceFailoverGroupsCreateOrUpdateOptionalParams)	Creates or updates a failover group.
beginCreateOrUpdateAndWait(string, string, string, InstanceFailoverGroup, InstanceFailoverGroupsCreateOrUpdateOptionalParams)	Creates or updates a failover group.
beginDelete(string, string, string, InstanceFailoverGroupsDeleteOptionalParams)	Deletes a failover group.
beginDeleteAndWait(string, string, string, InstanceFailoverGroupsDeleteOptionalParams)	Deletes a failover group.
beginFailover(string, string, string, InstanceFailoverGroupsFailoverOptionalParams)	Fails over from the current primary managed instance to this managed instance.
beginFailoverAndWait(string, string, string, InstanceFailoverGroupsFailoverOptionalParams)	Fails over from the current primary managed instance to this managed instance.
beginForceFailoverAllowDataLoss(string, string, string, InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams)	Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
beginForceFailoverAllowDataLossAndWait(string, string, string, InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams)	Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
get(string, string, string, InstanceFailoverGroupsGetOptionalParams)	Gets a failover group.
listByLocation(string, string, InstanceFailoverGroupsListByLocationOptionalParams)	Lists the failover groups in a location.

Method Details

beginCreateOrUpdate(string, string, string, InstanceFailoverGroup, InstanceFailoverGroupsCreateOrUpdateOptionalParams)

Creates or updates a failover group.

function beginCreateOrUpdate(resourceGroupName: string, locationName: string, failoverGroupName: string, parameters: InstanceFailoverGroup, options?: InstanceFailoverGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

parameters

InstanceFailoverGroup

The failover group parameters.

options

InstanceFailoverGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginCreateOrUpdateAndWait(string, string, string, InstanceFailoverGroup, InstanceFailoverGroupsCreateOrUpdateOptionalParams)

Creates or updates a failover group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, parameters: InstanceFailoverGroup, options?: InstanceFailoverGroupsCreateOrUpdateOptionalParams): Promise<InstanceFailoverGroup>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

parameters

InstanceFailoverGroup

The failover group parameters.

options

InstanceFailoverGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<InstanceFailoverGroup>

beginDelete(string, string, string, InstanceFailoverGroupsDeleteOptionalParams)

Deletes a failover group.

function beginDelete(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsDeleteOptionalParams): 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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, InstanceFailoverGroupsDeleteOptionalParams)

Deletes a failover group.

function beginDeleteAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsDeleteOptionalParams): 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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, string, InstanceFailoverGroupsFailoverOptionalParams)

Fails over from the current primary managed instance to this managed instance.

function beginFailover(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsFailoverOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginFailoverAndWait(string, string, string, InstanceFailoverGroupsFailoverOptionalParams)

Fails over from the current primary managed instance to this managed instance.

function beginFailoverAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsFailoverOptionalParams): Promise<InstanceFailoverGroup>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsFailoverOptionalParams

The options parameters.

Returns

Promise<InstanceFailoverGroup>

beginForceFailoverAllowDataLoss(string, string, string, InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams)

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

function beginForceFailoverAllowDataLoss(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginForceFailoverAllowDataLossAndWait(string, string, string, InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams)

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

function beginForceFailoverAllowDataLossAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<InstanceFailoverGroup>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

The options parameters.

Returns

Promise<InstanceFailoverGroup>

get(string, string, string, InstanceFailoverGroupsGetOptionalParams)

Gets a failover group.

function get(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsGetOptionalParams): Promise<InstanceFailoverGroup>

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.

locationName

string

The name of the region where the resource is located.

failoverGroupName

string

The name of the failover group.

options

InstanceFailoverGroupsGetOptionalParams

The options parameters.

Returns

Promise<InstanceFailoverGroup>

listByLocation(string, string, InstanceFailoverGroupsListByLocationOptionalParams)

Lists the failover groups in a location.

function listByLocation(resourceGroupName: string, locationName: string, options?: InstanceFailoverGroupsListByLocationOptionalParams): PagedAsyncIterableIterator<InstanceFailoverGroup, InstanceFailoverGroup[], 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.

locationName

string

The name of the region where the resource is located.

options

InstanceFailoverGroupsListByLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<InstanceFailoverGroup, InstanceFailoverGroup[], PageSettings>