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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
databases	array	List of databases in the failover group.
location	string	Resource location.
partnerServers	array	List of partner server information for the failover group. Required.
readOnlyEndpoint	object	Read-only endpoint of the failover group instance.
readWriteEndpoint	object	Read-write endpoint of the failover group instance. Required.
replicationRole	string	Local replication role of the failover group instance. Known values are: "Primary" and "Secondary". (Primary, Secondary)
replicationState	string	Replication state of the failover group instance.
secondaryType	string	Databases secondary type on partner server. Known values are: "Geo" and "Standby". (Geo, Standby)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
databases	array	List of databases in the failover group.
location	string	Resource location.
partnerServers	array	List of partner server information for the failover group. Required.
readOnlyEndpoint	object	Read-only endpoint of the failover group instance.
readWriteEndpoint	object	Read-write endpoint of the failover group instance. Required.
replicationRole	string	Local replication role of the failover group instance. Known values are: "Primary" and "Secondary". (Primary, Secondary)
replicationState	string	Replication state of the failover group instance.
secondaryType	string	Databases secondary type on partner server. Known values are: "Geo" and "Standby". (Geo, Standby)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, failover_group_name, subscription_id		Gets a failover group.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists the failover groups in a server.
create_or_update	insert	resource_group_name, server_name, failover_group_name, subscription_id		Creates or updates a failover group.
update	update	resource_group_name, server_name, failover_group_name, subscription_id		Updates a failover group.
create_or_update	replace	resource_group_name, server_name, failover_group_name, subscription_id		Creates or updates a failover group.
delete	delete	resource_group_name, server_name, failover_group_name, subscription_id		Deletes a failover group.
failover	exec	resource_group_name, server_name, failover_group_name, subscription_id		Fails over from the current primary server to this server.
force_failover_allow_data_loss	exec	resource_group_name, server_name, failover_group_name, subscription_id		Fails over from the current primary server to this server. This operation might result in data loss.
try_planned_before_forced_failover	exec	resource_group_name, server_name, failover_group_name, subscription_id		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
failover_group_name	string	The name of the failover group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a failover group.

SELECT
id,
name,
databases,
location,
partnerServers,
readOnlyEndpoint,
readWriteEndpoint,
replicationRole,
replicationState,
secondaryType,
systemData,
tags,
type
FROM azure.sql.failover_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND failover_group_name = '{{ failover_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists the failover groups in a server.

SELECT
id,
name,
databases,
location,
partnerServers,
readOnlyEndpoint,
readWriteEndpoint,
replicationRole,
replicationState,
secondaryType,
systemData,
tags,
type
FROM azure.sql.failover_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a failover group.

INSERT INTO azure.sql.failover_groups (
properties,
tags,
resource_group_name,
server_name,
failover_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ failover_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: failover_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the failover_groups resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the failover_groups resource.
  - name: failover_group_name
    value: "{{ failover_group_name }}"
    description: Required parameter for the failover_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the failover_groups resource.
  - name: properties
    description: |
      Resource properties.
    value:
      readWriteEndpoint:
        failoverPolicy: "{{ failoverPolicy }}"
        failoverWithDataLossGracePeriodMinutes: {{ failoverWithDataLossGracePeriodMinutes }}
      readOnlyEndpoint:
        failoverPolicy: "{{ failoverPolicy }}"
        targetServer: "{{ targetServer }}"
      replicationRole: "{{ replicationRole }}"
      replicationState: "{{ replicationState }}"
      partnerServers:
        - id: "{{ id }}"
          location: "{{ location }}"
          replicationRole: "{{ replicationRole }}"
      databases:
        - "{{ databases }}"
      secondaryType: "{{ secondaryType }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

UPDATE examples

update

Updates a failover group.

UPDATE azure.sql.failover_groups
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND failover_group_name = '{{ failover_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a failover group.

REPLACE azure.sql.failover_groups
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND failover_group_name = '{{ failover_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a failover group.

DELETE FROM azure.sql.failover_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND failover_group_name = '{{ failover_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

failover

Fails over from the current primary server to this server.

EXEC azure.sql.failover_groups.failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@failover_group_name='{{ failover_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@failover_group_name='{{ failover_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@failover_group_name='{{ failover_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;