sql_server_availability_groups

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

Overview

Name	sql_server_availability_groups
Type	Resource
Id	azure.azure_arc_data.sql_server_availability_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Arc Sql Server availability group
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Arc Sql Server availability group
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Retrieves an Arc Sql Server availability group.
list	select	subscriptionId, resourceGroupName, sqlServerInstanceName
create	insert	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName, data__properties		Creates or replaces an Arc Sql Server Availability Group.
update	update	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Updates an existing Availability Group.
delete	delete	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Deletes an Arc Sql Server availability group resource.
detail_view	exec	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Retrieves detailed properties of the Availability Group.
failover	exec	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Request manual failover of the availability group to this server.
force_failover_allow_data_loss	exec	subscriptionId, resourceGroupName, sqlServerInstanceName, availabilityGroupName		Request forced failover of the availability group to this server.

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
availabilityGroupName	string	Name of SQL Availability Group
resourceGroupName	string	The name of the Azure resource group
sqlServerInstanceName	string	Name of SQL Server Instance
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Retrieves an Arc Sql Server availability group.

SELECT
location,
properties,
tags
FROM azure.azure_arc_data.sql_server_availability_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' -- required
AND availabilityGroupName = '{{ availabilityGroupName }}' -- required
;

list

OK

SELECT
location,
properties,
tags
FROM azure.azure_arc_data.sql_server_availability_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' -- required
;

INSERT examples

create

Creates or replaces an Arc Sql Server Availability Group.

INSERT INTO azure.azure_arc_data.sql_server_availability_groups (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
sqlServerInstanceName,
availabilityGroupName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ sqlServerInstanceName }}',
'{{ availabilityGroupName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sql_server_availability_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_server_availability_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_server_availability_groups resource.
    - name: sqlServerInstanceName
      value: string
      description: Required parameter for the sql_server_availability_groups resource.
    - name: availabilityGroupName
      value: string
      description: Required parameter for the sql_server_availability_groups resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of Arc Sql Server availability group

UPDATE examples

update

Updates an existing Availability Group.

UPDATE azure.azure_arc_data.sql_server_availability_groups
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' --required
AND availabilityGroupName = '{{ availabilityGroupName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an Arc Sql Server availability group resource.

DELETE FROM azure.azure_arc_data.sql_server_availability_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND sqlServerInstanceName = '{{ sqlServerInstanceName }}' --required
AND availabilityGroupName = '{{ availabilityGroupName }}' --required
;

Lifecycle Methods

detail_view

Retrieves detailed properties of the Availability Group.

EXEC azure.azure_arc_data.sql_server_availability_groups.detail_view 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlServerInstanceName='{{ sqlServerInstanceName }}' --required, 
@availabilityGroupName='{{ availabilityGroupName }}' --required
;

failover

Request manual failover of the availability group to this server.

EXEC azure.azure_arc_data.sql_server_availability_groups.failover 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlServerInstanceName='{{ sqlServerInstanceName }}' --required, 
@availabilityGroupName='{{ availabilityGroupName }}' --required
;

force_failover_allow_data_loss

Request forced failover of the availability group to this server.

EXEC azure.azure_arc_data.sql_server_availability_groups.force_failover_allow_data_loss 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@sqlServerInstanceName='{{ sqlServerInstanceName }}' --required, 
@availabilityGroupName='{{ availabilityGroupName }}' --required
;