Package version:

Interface FailoverGroups

Interface representing a FailoverGroups.

Hierarchy

FailoverGroups

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginFailover beginFailoverAndWait beginForceFailoverAllowDataLoss beginForceFailoverAllowDataLossAndWait beginUpdate beginUpdateAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroup, options?: FailoverGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
Creates or updates a failover group.
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.
- Optional options: FailoverGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
- Defined in operationsInterfaces/failoverGroups.ts:66

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroup, options?: FailoverGroupsCreateOrUpdateOptionalParams): Promise<FailoverGroup>
Creates or updates a failover group.
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.
- Optional options: FailoverGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:87

beginDelete

beginDelete(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a failover group.
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.
- Optional options: FailoverGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/failoverGroups.ts:102

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsDeleteOptionalParams): Promise<void>
Deletes a failover group.
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.
- Optional options: FailoverGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/failoverGroups.ts:116

beginFailover

beginFailover(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
Fails over from the current primary server to this server.
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.
- Optional options: FailoverGroupsFailoverOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
- Defined in operationsInterfaces/failoverGroups.ts:167

beginFailoverAndWait

beginFailoverAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsFailoverOptionalParams): Promise<FailoverGroup>
Fails over from the current primary server to this server.
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.
- Optional options: FailoverGroupsFailoverOptionalParams
  
  The options parameters.
Returns Promise<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:186

beginForceFailoverAllowDataLoss

beginForceFailoverAllowDataLoss(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
Fails over from the current primary server to this server. This operation might result in data loss.
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.
- Optional options: FailoverGroupsForceFailoverAllowDataLossOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
- Defined in operationsInterfaces/failoverGroups.ts:200

beginForceFailoverAllowDataLossAndWait

beginForceFailoverAllowDataLossAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<FailoverGroup>
Fails over from the current primary server to this server. This operation might result in data loss.
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.
- Optional options: FailoverGroupsForceFailoverAllowDataLossOptionalParams
  
  The options parameters.
Returns Promise<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:219

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroupUpdate, options?: FailoverGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
Updates a failover group.
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.
- Optional options: FailoverGroupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
- Defined in operationsInterfaces/failoverGroups.ts:131

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, failoverGroupName: string, parameters: FailoverGroupUpdate, options?: FailoverGroupsUpdateOptionalParams): Promise<FailoverGroup>
Updates a failover group.
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.
- Optional options: FailoverGroupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:152

get

get(resourceGroupName: string, serverName: string, failoverGroupName: string, options?: FailoverGroupsGetOptionalParams): Promise<FailoverGroup>
Gets a failover group.
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.
- Optional options: FailoverGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:51

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: FailoverGroupsListByServerOptionalParams): PagedAsyncIterableIterator<FailoverGroup>
Lists the failover groups in a server.
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.
- Optional options: FailoverGroupsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<FailoverGroup>
- Defined in operationsInterfaces/failoverGroups.ts:38

Interface FailoverGroups

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

parameters: FailoverGroup

Optional options: FailoverGroupsCreateOrUpdateOptionalParams

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

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

parameters: FailoverGroup

Optional options: FailoverGroupsCreateOrUpdateOptionalParams

Returns Promise<FailoverGroup>

beginDelete

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsDeleteOptionalParams

Returns Promise<void>

beginFailover

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsFailoverOptionalParams

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

beginFailoverAndWait

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsFailoverOptionalParams

Returns Promise<FailoverGroup>

beginForceFailoverAllowDataLoss

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsForceFailoverAllowDataLossOptionalParams

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

beginForceFailoverAllowDataLossAndWait

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

Optional options: FailoverGroupsForceFailoverAllowDataLossOptionalParams

Returns Promise<FailoverGroup>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

parameters: FailoverGroupUpdate

Optional options: FailoverGroupsUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

failoverGroupName: string

parameters: FailoverGroupUpdate

Optional options: FailoverGroupsUpdateOptionalParams

Returns Promise<FailoverGroup>

get

`Optional` options: FailoverGroupsCreateOrUpdateOptionalParams

`Optional` options: FailoverGroupsCreateOrUpdateOptionalParams

`Optional` options: FailoverGroupsDeleteOptionalParams

`Optional` options: FailoverGroupsDeleteOptionalParams

`Optional` options: FailoverGroupsFailoverOptionalParams

`Optional` options: FailoverGroupsFailoverOptionalParams

`Optional` options: FailoverGroupsForceFailoverAllowDataLossOptionalParams

`Optional` options: FailoverGroupsForceFailoverAllowDataLossOptionalParams

`Optional` options: FailoverGroupsUpdateOptionalParams

`Optional` options: FailoverGroupsUpdateOptionalParams

`Optional` options: FailoverGroupsGetOptionalParams

`Optional` options: FailoverGroupsListByServerOptionalParams