distributed_availability_groups

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

Overview

Name	distributed_availability_groups
Type	Resource
Id	azure.sql.distributed_availability_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the distributed availability group.

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, managedInstanceName, distributedAvailabilityGroupName, subscriptionId		Gets a distributed availability group info.
create_or_update	insert	resourceGroupName, managedInstanceName, distributedAvailabilityGroupName, subscriptionId		Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
update	update	resourceGroupName, managedInstanceName, distributedAvailabilityGroupName, subscriptionId		Updates a distributed availability group replication mode.
delete	delete	resourceGroupName, managedInstanceName, distributedAvailabilityGroupName, subscriptionId		Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

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
distributedAvailabilityGroupName	string	The distributed availability group name.
managedInstanceName	string	The name of the managed instance.
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 distributed availability group info.

SELECT
properties
FROM azure.sql.distributed_availability_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND distributedAvailabilityGroupName = '{{ distributedAvailabilityGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.

INSERT INTO azure.sql.distributed_availability_groups (
data__properties,
resourceGroupName,
managedInstanceName,
distributedAvailabilityGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ distributedAvailabilityGroupName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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

UPDATE examples

update

Updates a distributed availability group replication mode.

UPDATE azure.sql.distributed_availability_groups
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND distributedAvailabilityGroupName = '{{ distributedAvailabilityGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

DELETE FROM azure.sql.distributed_availability_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND distributedAvailabilityGroupName = '{{ distributedAvailabilityGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;