failover_groups

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

Overview

Name	failover_groups
Type	Resource
Id	azure.azure_arc_data.failover_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	null

list

Name	Datatype	Description
properties	object	null

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, sqlManagedInstanceName, failoverGroupName	api-version	Retrieves a failover group resource
list	select	subscriptionId, resourceGroupName, sqlManagedInstanceName	api-version
create	insert	subscriptionId, resourceGroupName, sqlManagedInstanceName, failoverGroupName, data__properties	api-version	Creates or replaces a failover group resource.
delete	delete	subscriptionId, resourceGroupName, sqlManagedInstanceName, failoverGroupName	api-version	Deletes a failover group resource

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 Azure resource group
sqlManagedInstanceName	string	Name of SQL Managed Instance
subscriptionId	string	The ID of the Azure subscription
api-version	string	The API version to use for the request

SELECT examples

get

Retrieves a failover group resource

SELECT
properties
FROM azure.azure_arc_data.failover_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlManagedInstanceName = '{{ sqlManagedInstanceName }}' -- required
AND failoverGroupName = '{{ failoverGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

OK

SELECT
properties
FROM azure.azure_arc_data.failover_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlManagedInstanceName = '{{ sqlManagedInstanceName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates or replaces a failover group resource.

INSERT INTO azure.azure_arc_data.failover_groups (
data__properties,
subscriptionId,
resourceGroupName,
sqlManagedInstanceName,
failoverGroupName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sqlManagedInstanceName }}',
'{{ failoverGroupName }}',
'{{ api-version }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: failover_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the failover_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the failover_groups resource.
    - name: sqlManagedInstanceName
      value: string
      description: Required parameter for the failover_groups resource.
    - name: failoverGroupName
      value: string
      description: Required parameter for the failover_groups resource.
    - name: properties
      value: object
      description: |
        null
    - name: api-version
      value: string
      description: The API version to use for the request

DELETE examples

delete

Deletes a failover group resource

DELETE FROM azure.azure_arc_data.failover_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlManagedInstanceName = '{{ sqlManagedInstanceName }}' --required
AND failoverGroupName = '{{ failoverGroupName }}' --required
AND api-version = '{{ api-version }}'
;