failover_groups

Creates, updates, deletes, gets or lists a failover_groups resource.

Overview

Name	failover_groups
Type	Resource
Id	azure.sql.failover_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified failover group.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

list_by_server

Successfully retrieved the failover groups.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, failoverGroupName, subscriptionId		Gets a failover group.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Lists the failover groups in a server.
create_or_update	insert	resourceGroupName, serverName, failoverGroupName, subscriptionId		Creates or updates a failover group.
update	update	resourceGroupName, serverName, failoverGroupName, subscriptionId		Updates a failover group.
delete	delete	resourceGroupName, serverName, failoverGroupName, subscriptionId		Deletes a failover group.
failover	exec	resourceGroupName, serverName, failoverGroupName, subscriptionId		Fails over from the current primary server to this server.
force_failover_allow_data_loss	exec	resourceGroupName, serverName, failoverGroupName, subscriptionId		Fails over from the current primary server to this server. This operation might result in data loss.
try_planned_before_forced_failover	exec	resourceGroupName, serverName, failoverGroupName, subscriptionId		Fails over from the current primary server to this server. This operation tries planned before forced failover but might still 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.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a failover group.

SELECT
location,
properties,
tags
FROM azure.sql.failover_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND failoverGroupName = '{{ failoverGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Lists the failover groups in a server.

SELECT
location,
properties,
tags
FROM azure.sql.failover_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a failover group.

INSERT INTO azure.sql.failover_groups (
data__tags,
data__properties,
resourceGroupName,
serverName,
failoverGroupName,
subscriptionId
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ failoverGroupName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
tags
;

Manifest

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

UPDATE examples

update

Updates a failover group.

UPDATE azure.sql.failover_groups
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND failoverGroupName = '{{ failoverGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a failover group.

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

Lifecycle Methods

failover

Fails over from the current primary server to this server.

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

force_failover_allow_data_loss

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

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

try_planned_before_forced_failover

Fails over from the current primary server to this server. This operation tries planned before forced failover but might still result in data loss.

EXEC azure.sql.failover_groups.try_planned_before_forced_failover 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@failoverGroupName='{{ failoverGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;