instance_failover_groups

Creates, updates, deletes, gets or lists an instance_failover_groups resource.

Overview

Name	instance_failover_groups
Type	Resource
Id	azure.sql.instance_failover_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified failover group.

Name	Datatype	Description
properties	object	Resource properties.

list_by_location

Successfully retrieved the failover groups.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, locationName, failoverGroupName, subscriptionId		Gets a failover group.
list_by_location	select	resourceGroupName, locationName, subscriptionId		Lists the failover groups in a location.
create_or_update	insert	resourceGroupName, locationName, failoverGroupName, subscriptionId		Creates or updates a failover group.
delete	delete	resourceGroupName, locationName, failoverGroupName, subscriptionId		Deletes a failover group.
failover	exec	resourceGroupName, locationName, failoverGroupName, subscriptionId		Fails over from the current primary managed instance to this managed instance.
force_failover_allow_data_loss	exec	resourceGroupName, locationName, failoverGroupName, subscriptionId		Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
failoverGroupName	string	The name of the failover group.
locationName	string	The name of the region where the resource is located.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a failover group.

SELECT
properties
FROM azure.sql.instance_failover_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND failoverGroupName = '{{ failoverGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_location

Lists the failover groups in a location.

SELECT
properties
FROM azure.sql.instance_failover_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a failover group.

INSERT INTO azure.sql.instance_failover_groups (
data__properties,
resourceGroupName,
locationName,
failoverGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ locationName }}',
'{{ failoverGroupName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: instance_failover_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the instance_failover_groups resource.
    - name: locationName
      value: string
      description: Required parameter for the instance_failover_groups resource.
    - name: failoverGroupName
      value: string
      description: Required parameter for the instance_failover_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the instance_failover_groups resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a failover group.

DELETE FROM azure.sql.instance_failover_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND locationName = '{{ locationName }}' --required
AND failoverGroupName = '{{ failoverGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

failover

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

EXEC azure.sql.instance_failover_groups.failover 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@locationName='{{ locationName }}' --required, 
@failoverGroupName='{{ failoverGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

force_failover_allow_data_loss

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

EXEC azure.sql.instance_failover_groups.force_failover_allow_data_loss 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@locationName='{{ locationName }}' --required, 
@failoverGroupName='{{ failoverGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;