Package version:

Interface InstanceFailoverGroups

Interface representing a InstanceFailoverGroups.

Hierarchy

InstanceFailoverGroups

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginFailover beginFailoverAndWait beginForceFailoverAllowDataLoss beginForceFailoverAllowDataLossAndWait get listByLocation

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, locationName: string, failoverGroupName: string, parameters: InstanceFailoverGroup, options?: InstanceFailoverGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
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.
- 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.
- Optional options: InstanceFailoverGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:63

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, parameters: InstanceFailoverGroup, options?: InstanceFailoverGroupsCreateOrUpdateOptionalParams): Promise<InstanceFailoverGroup>
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.
- 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.
- Optional options: InstanceFailoverGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<InstanceFailoverGroup>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:84

beginDelete

beginDelete(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsDeleteOptionalParams): 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.
- locationName: string
  
  The name of the region where the resource is located.
- failoverGroupName: string
  
  The name of the failover group.
- Optional options: InstanceFailoverGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:99

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsDeleteOptionalParams): 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.
- locationName: string
  
  The name of the region where the resource is located.
- failoverGroupName: string
  
  The name of the failover group.
- Optional options: InstanceFailoverGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:113

beginFailover

beginFailover(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
Fails over from the current primary managed instance to this managed instance.
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.
- Optional options: InstanceFailoverGroupsFailoverOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:127

beginFailoverAndWait

beginFailoverAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsFailoverOptionalParams): Promise<InstanceFailoverGroup>
Fails over from the current primary managed instance to this managed instance.
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.
- Optional options: InstanceFailoverGroupsFailoverOptionalParams
  
  The options parameters.
Returns Promise<InstanceFailoverGroup>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:146

beginForceFailoverAllowDataLoss

beginForceFailoverAllowDataLoss(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
Fails over from the current primary managed instance to this managed instance. 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.
- locationName: string
  
  The name of the region where the resource is located.
- failoverGroupName: string
  
  The name of the failover group.
- Optional options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:161

beginForceFailoverAllowDataLossAndWait

beginForceFailoverAllowDataLossAndWait(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams): Promise<InstanceFailoverGroup>
Fails over from the current primary managed instance to this managed instance. 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.
- locationName: string
  
  The name of the region where the resource is located.
- failoverGroupName: string
  
  The name of the failover group.
- Optional options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams
  
  The options parameters.
Returns Promise<InstanceFailoverGroup>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:181

get

get(resourceGroupName: string, locationName: string, failoverGroupName: string, options?: InstanceFailoverGroupsGetOptionalParams): Promise<InstanceFailoverGroup>
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.
- locationName: string
  
  The name of the region where the resource is located.
- failoverGroupName: string
  
  The name of the failover group.
- Optional options: InstanceFailoverGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<InstanceFailoverGroup>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:48

listByLocation

listByLocation(resourceGroupName: string, locationName: string, options?: InstanceFailoverGroupsListByLocationOptionalParams): PagedAsyncIterableIterator<InstanceFailoverGroup>
Lists the failover groups in a location.
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.
- Optional options: InstanceFailoverGroupsListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<InstanceFailoverGroup>
- Defined in operationsInterfaces/instanceFailoverGroups.ts:35

Interface InstanceFailoverGroups

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

parameters: InstanceFailoverGroup

Optional options: InstanceFailoverGroupsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

parameters: InstanceFailoverGroup

Optional options: InstanceFailoverGroupsCreateOrUpdateOptionalParams

Returns Promise<InstanceFailoverGroup>

beginDelete

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsDeleteOptionalParams

Returns Promise<void>

beginFailover

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsFailoverOptionalParams

Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginFailoverAndWait

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsFailoverOptionalParams

Returns Promise<InstanceFailoverGroup>

beginForceFailoverAllowDataLoss

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

Returns Promise<SimplePollerLike<OperationState<InstanceFailoverGroup>, InstanceFailoverGroup>>

beginForceFailoverAllowDataLossAndWait

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

Returns Promise<InstanceFailoverGroup>

get

Parameters

resourceGroupName: string

locationName: string

failoverGroupName: string

Optional options: InstanceFailoverGroupsGetOptionalParams

Returns Promise<InstanceFailoverGroup>

listByLocation

Parameters

resourceGroupName: string

locationName: string

Optional options: InstanceFailoverGroupsListByLocationOptionalParams

Returns PagedAsyncIterableIterator<InstanceFailoverGroup>

Settings

Member Visibility

Theme

`Optional` options: InstanceFailoverGroupsCreateOrUpdateOptionalParams

`Optional` options: InstanceFailoverGroupsCreateOrUpdateOptionalParams

`Optional` options: InstanceFailoverGroupsDeleteOptionalParams

`Optional` options: InstanceFailoverGroupsDeleteOptionalParams

`Optional` options: InstanceFailoverGroupsFailoverOptionalParams

`Optional` options: InstanceFailoverGroupsFailoverOptionalParams

`Optional` options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

`Optional` options: InstanceFailoverGroupsForceFailoverAllowDataLossOptionalParams

`Optional` options: InstanceFailoverGroupsGetOptionalParams

`Optional` options: InstanceFailoverGroupsListByLocationOptionalParams