1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. DistributedAvailabilityGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.sql.DistributedAvailabilityGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Distributed availability group between box and Sql Managed Instance.

    Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01.

    Other available API versions: 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Example Usage

    Create a distributed availability group with all properties.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var distributedAvailabilityGroup = new AzureNative.Sql.DistributedAvailabilityGroup("distributedAvailabilityGroup", new()
        {
            Databases = new[]
            {
                new AzureNative.Sql.Inputs.DistributedAvailabilityGroupDatabaseArgs
                {
                    DatabaseName = "testdb",
                },
            },
            DistributedAvailabilityGroupName = "dag",
            FailoverMode = AzureNative.Sql.FailoverModeType.None,
            InstanceAvailabilityGroupName = "testcl",
            InstanceLinkRole = AzureNative.Sql.LinkRole.Primary,
            ManagedInstanceName = "testcl",
            PartnerAvailabilityGroupName = "BoxLocalAg1",
            PartnerEndpoint = "TCP://SERVER:7022",
            ResourceGroupName = "testrg",
            SeedingMode = AzureNative.Sql.SeedingModeType.Automatic,
        });
    
    });
    
    package main
    
    import (
    	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sql.NewDistributedAvailabilityGroup(ctx, "distributedAvailabilityGroup", &sql.DistributedAvailabilityGroupArgs{
    			Databases: sql.DistributedAvailabilityGroupDatabaseArray{
    				&sql.DistributedAvailabilityGroupDatabaseArgs{
    					DatabaseName: pulumi.String("testdb"),
    				},
    			},
    			DistributedAvailabilityGroupName: pulumi.String("dag"),
    			FailoverMode:                     pulumi.String(sql.FailoverModeTypeNone),
    			InstanceAvailabilityGroupName:    pulumi.String("testcl"),
    			InstanceLinkRole:                 pulumi.String(sql.LinkRolePrimary),
    			ManagedInstanceName:              pulumi.String("testcl"),
    			PartnerAvailabilityGroupName:     pulumi.String("BoxLocalAg1"),
    			PartnerEndpoint:                  pulumi.String("TCP://SERVER:7022"),
    			ResourceGroupName:                pulumi.String("testrg"),
    			SeedingMode:                      pulumi.String(sql.SeedingModeTypeAutomatic),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.sql.DistributedAvailabilityGroup;
    import com.pulumi.azurenative.sql.DistributedAvailabilityGroupArgs;
    import com.pulumi.azurenative.sql.inputs.DistributedAvailabilityGroupDatabaseArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var distributedAvailabilityGroup = new DistributedAvailabilityGroup("distributedAvailabilityGroup", DistributedAvailabilityGroupArgs.builder()
                .databases(DistributedAvailabilityGroupDatabaseArgs.builder()
                    .databaseName("testdb")
                    .build())
                .distributedAvailabilityGroupName("dag")
                .failoverMode("None")
                .instanceAvailabilityGroupName("testcl")
                .instanceLinkRole("Primary")
                .managedInstanceName("testcl")
                .partnerAvailabilityGroupName("BoxLocalAg1")
                .partnerEndpoint("TCP://SERVER:7022")
                .resourceGroupName("testrg")
                .seedingMode("Automatic")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const distributedAvailabilityGroup = new azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroup", {
        databases: [{
            databaseName: "testdb",
        }],
        distributedAvailabilityGroupName: "dag",
        failoverMode: azure_native.sql.FailoverModeType.None,
        instanceAvailabilityGroupName: "testcl",
        instanceLinkRole: azure_native.sql.LinkRole.Primary,
        managedInstanceName: "testcl",
        partnerAvailabilityGroupName: "BoxLocalAg1",
        partnerEndpoint: "TCP://SERVER:7022",
        resourceGroupName: "testrg",
        seedingMode: azure_native.sql.SeedingModeType.Automatic,
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    distributed_availability_group = azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroup",
        databases=[{
            "database_name": "testdb",
        }],
        distributed_availability_group_name="dag",
        failover_mode=azure_native.sql.FailoverModeType.NONE,
        instance_availability_group_name="testcl",
        instance_link_role=azure_native.sql.LinkRole.PRIMARY,
        managed_instance_name="testcl",
        partner_availability_group_name="BoxLocalAg1",
        partner_endpoint="TCP://SERVER:7022",
        resource_group_name="testrg",
        seeding_mode=azure_native.sql.SeedingModeType.AUTOMATIC)
    
    resources:
      distributedAvailabilityGroup:
        type: azure-native:sql:DistributedAvailabilityGroup
        properties:
          databases:
            - databaseName: testdb
          distributedAvailabilityGroupName: dag
          failoverMode: None
          instanceAvailabilityGroupName: testcl
          instanceLinkRole: Primary
          managedInstanceName: testcl
          partnerAvailabilityGroupName: BoxLocalAg1
          partnerEndpoint: TCP://SERVER:7022
          resourceGroupName: testrg
          seedingMode: Automatic
    

    Create a distributed availability group with minimal properties.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var distributedAvailabilityGroup = new AzureNative.Sql.DistributedAvailabilityGroup("distributedAvailabilityGroup", new()
        {
            Databases = new[]
            {
                new AzureNative.Sql.Inputs.DistributedAvailabilityGroupDatabaseArgs
                {
                    DatabaseName = "testdb",
                },
            },
            DistributedAvailabilityGroupName = "dag",
            InstanceAvailabilityGroupName = "testcl",
            ManagedInstanceName = "testcl",
            PartnerAvailabilityGroupName = "BoxLocalAg1",
            PartnerEndpoint = "TCP://SERVER:7022",
            ResourceGroupName = "testrg",
        });
    
    });
    
    package main
    
    import (
    	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sql.NewDistributedAvailabilityGroup(ctx, "distributedAvailabilityGroup", &sql.DistributedAvailabilityGroupArgs{
    			Databases: sql.DistributedAvailabilityGroupDatabaseArray{
    				&sql.DistributedAvailabilityGroupDatabaseArgs{
    					DatabaseName: pulumi.String("testdb"),
    				},
    			},
    			DistributedAvailabilityGroupName: pulumi.String("dag"),
    			InstanceAvailabilityGroupName:    pulumi.String("testcl"),
    			ManagedInstanceName:              pulumi.String("testcl"),
    			PartnerAvailabilityGroupName:     pulumi.String("BoxLocalAg1"),
    			PartnerEndpoint:                  pulumi.String("TCP://SERVER:7022"),
    			ResourceGroupName:                pulumi.String("testrg"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.sql.DistributedAvailabilityGroup;
    import com.pulumi.azurenative.sql.DistributedAvailabilityGroupArgs;
    import com.pulumi.azurenative.sql.inputs.DistributedAvailabilityGroupDatabaseArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var distributedAvailabilityGroup = new DistributedAvailabilityGroup("distributedAvailabilityGroup", DistributedAvailabilityGroupArgs.builder()
                .databases(DistributedAvailabilityGroupDatabaseArgs.builder()
                    .databaseName("testdb")
                    .build())
                .distributedAvailabilityGroupName("dag")
                .instanceAvailabilityGroupName("testcl")
                .managedInstanceName("testcl")
                .partnerAvailabilityGroupName("BoxLocalAg1")
                .partnerEndpoint("TCP://SERVER:7022")
                .resourceGroupName("testrg")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const distributedAvailabilityGroup = new azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroup", {
        databases: [{
            databaseName: "testdb",
        }],
        distributedAvailabilityGroupName: "dag",
        instanceAvailabilityGroupName: "testcl",
        managedInstanceName: "testcl",
        partnerAvailabilityGroupName: "BoxLocalAg1",
        partnerEndpoint: "TCP://SERVER:7022",
        resourceGroupName: "testrg",
    });
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    distributed_availability_group = azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroup",
        databases=[{
            "database_name": "testdb",
        }],
        distributed_availability_group_name="dag",
        instance_availability_group_name="testcl",
        managed_instance_name="testcl",
        partner_availability_group_name="BoxLocalAg1",
        partner_endpoint="TCP://SERVER:7022",
        resource_group_name="testrg")
    
    resources:
      distributedAvailabilityGroup:
        type: azure-native:sql:DistributedAvailabilityGroup
        properties:
          databases:
            - databaseName: testdb
          distributedAvailabilityGroupName: dag
          instanceAvailabilityGroupName: testcl
          managedInstanceName: testcl
          partnerAvailabilityGroupName: BoxLocalAg1
          partnerEndpoint: TCP://SERVER:7022
          resourceGroupName: testrg
    

    Create DistributedAvailabilityGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DistributedAvailabilityGroup(name: string, args: DistributedAvailabilityGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DistributedAvailabilityGroup(resource_name: str,
                                     args: DistributedAvailabilityGroupArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def DistributedAvailabilityGroup(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     managed_instance_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     databases: Optional[Sequence[DistributedAvailabilityGroupDatabaseArgs]] = None,
                                     distributed_availability_group_name: Optional[str] = None,
                                     failover_mode: Optional[Union[str, FailoverModeType]] = None,
                                     instance_availability_group_name: Optional[str] = None,
                                     instance_link_role: Optional[Union[str, LinkRole]] = None,
                                     partner_availability_group_name: Optional[str] = None,
                                     partner_endpoint: Optional[str] = None,
                                     replication_mode: Optional[Union[str, ReplicationModeType]] = None,
                                     seeding_mode: Optional[Union[str, SeedingModeType]] = None)
    func NewDistributedAvailabilityGroup(ctx *Context, name string, args DistributedAvailabilityGroupArgs, opts ...ResourceOption) (*DistributedAvailabilityGroup, error)
    public DistributedAvailabilityGroup(string name, DistributedAvailabilityGroupArgs args, CustomResourceOptions? opts = null)
    public DistributedAvailabilityGroup(String name, DistributedAvailabilityGroupArgs args)
    public DistributedAvailabilityGroup(String name, DistributedAvailabilityGroupArgs args, CustomResourceOptions options)
    
    type: azure-native:sql:DistributedAvailabilityGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DistributedAvailabilityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DistributedAvailabilityGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DistributedAvailabilityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DistributedAvailabilityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DistributedAvailabilityGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var distributedAvailabilityGroupResource = new AzureNative.Sql.DistributedAvailabilityGroup("distributedAvailabilityGroupResource", new()
    {
        ManagedInstanceName = "string",
        ResourceGroupName = "string",
        Databases = new[]
        {
            new AzureNative.Sql.Inputs.DistributedAvailabilityGroupDatabaseArgs
            {
                DatabaseName = "string",
            },
        },
        DistributedAvailabilityGroupName = "string",
        FailoverMode = "string",
        InstanceAvailabilityGroupName = "string",
        InstanceLinkRole = "string",
        PartnerAvailabilityGroupName = "string",
        PartnerEndpoint = "string",
        ReplicationMode = "string",
        SeedingMode = "string",
    });
    
    example, err := sql.NewDistributedAvailabilityGroup(ctx, "distributedAvailabilityGroupResource", &sql.DistributedAvailabilityGroupArgs{
    	ManagedInstanceName: pulumi.String("string"),
    	ResourceGroupName:   pulumi.String("string"),
    	Databases: sql.DistributedAvailabilityGroupDatabaseArray{
    		&sql.DistributedAvailabilityGroupDatabaseArgs{
    			DatabaseName: pulumi.String("string"),
    		},
    	},
    	DistributedAvailabilityGroupName: pulumi.String("string"),
    	FailoverMode:                     pulumi.String("string"),
    	InstanceAvailabilityGroupName:    pulumi.String("string"),
    	InstanceLinkRole:                 pulumi.String("string"),
    	PartnerAvailabilityGroupName:     pulumi.String("string"),
    	PartnerEndpoint:                  pulumi.String("string"),
    	ReplicationMode:                  pulumi.String("string"),
    	SeedingMode:                      pulumi.String("string"),
    })
    
    var distributedAvailabilityGroupResource = new DistributedAvailabilityGroup("distributedAvailabilityGroupResource", DistributedAvailabilityGroupArgs.builder()
        .managedInstanceName("string")
        .resourceGroupName("string")
        .databases(DistributedAvailabilityGroupDatabaseArgs.builder()
            .databaseName("string")
            .build())
        .distributedAvailabilityGroupName("string")
        .failoverMode("string")
        .instanceAvailabilityGroupName("string")
        .instanceLinkRole("string")
        .partnerAvailabilityGroupName("string")
        .partnerEndpoint("string")
        .replicationMode("string")
        .seedingMode("string")
        .build());
    
    distributed_availability_group_resource = azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroupResource",
        managed_instance_name="string",
        resource_group_name="string",
        databases=[{
            "database_name": "string",
        }],
        distributed_availability_group_name="string",
        failover_mode="string",
        instance_availability_group_name="string",
        instance_link_role="string",
        partner_availability_group_name="string",
        partner_endpoint="string",
        replication_mode="string",
        seeding_mode="string")
    
    const distributedAvailabilityGroupResource = new azure_native.sql.DistributedAvailabilityGroup("distributedAvailabilityGroupResource", {
        managedInstanceName: "string",
        resourceGroupName: "string",
        databases: [{
            databaseName: "string",
        }],
        distributedAvailabilityGroupName: "string",
        failoverMode: "string",
        instanceAvailabilityGroupName: "string",
        instanceLinkRole: "string",
        partnerAvailabilityGroupName: "string",
        partnerEndpoint: "string",
        replicationMode: "string",
        seedingMode: "string",
    });
    
    type: azure-native:sql:DistributedAvailabilityGroup
    properties:
        databases:
            - databaseName: string
        distributedAvailabilityGroupName: string
        failoverMode: string
        instanceAvailabilityGroupName: string
        instanceLinkRole: string
        managedInstanceName: string
        partnerAvailabilityGroupName: string
        partnerEndpoint: string
        replicationMode: string
        resourceGroupName: string
        seedingMode: string
    

    DistributedAvailabilityGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DistributedAvailabilityGroup resource accepts the following input properties:

    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.
    Databases List<Pulumi.AzureNative.Sql.Inputs.DistributedAvailabilityGroupDatabase>
    Databases in the distributed availability group
    DistributedAvailabilityGroupName string
    The distributed availability group name.
    FailoverMode string | Pulumi.AzureNative.Sql.FailoverModeType
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    InstanceAvailabilityGroupName string
    Managed instance side availability group name
    InstanceLinkRole string | Pulumi.AzureNative.Sql.LinkRole
    Managed instance side link role
    PartnerAvailabilityGroupName string
    SQL server side availability group name
    PartnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    ReplicationMode string | Pulumi.AzureNative.Sql.ReplicationModeType
    Replication mode of the link
    SeedingMode string | Pulumi.AzureNative.Sql.SeedingModeType
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    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.
    Databases []DistributedAvailabilityGroupDatabaseArgs
    Databases in the distributed availability group
    DistributedAvailabilityGroupName string
    The distributed availability group name.
    FailoverMode string | FailoverModeType
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    InstanceAvailabilityGroupName string
    Managed instance side availability group name
    InstanceLinkRole string | LinkRole
    Managed instance side link role
    PartnerAvailabilityGroupName string
    SQL server side availability group name
    PartnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    ReplicationMode string | ReplicationModeType
    Replication mode of the link
    SeedingMode string | SeedingModeType
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    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.
    databases List<DistributedAvailabilityGroupDatabase>
    Databases in the distributed availability group
    distributedAvailabilityGroupName String
    The distributed availability group name.
    failoverMode String | FailoverModeType
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName String
    Managed instance side availability group name
    instanceLinkRole String | LinkRole
    Managed instance side link role
    partnerAvailabilityGroupName String
    SQL server side availability group name
    partnerEndpoint String
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode String | ReplicationModeType
    Replication mode of the link
    seedingMode String | SeedingModeType
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    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.
    databases DistributedAvailabilityGroupDatabase[]
    Databases in the distributed availability group
    distributedAvailabilityGroupName string
    The distributed availability group name.
    failoverMode string | FailoverModeType
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName string
    Managed instance side availability group name
    instanceLinkRole string | LinkRole
    Managed instance side link role
    partnerAvailabilityGroupName string
    SQL server side availability group name
    partnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode string | ReplicationModeType
    Replication mode of the link
    seedingMode string | SeedingModeType
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    managed_instance_name str
    The name of the managed instance.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    databases Sequence[DistributedAvailabilityGroupDatabaseArgs]
    Databases in the distributed availability group
    distributed_availability_group_name str
    The distributed availability group name.
    failover_mode str | FailoverModeType
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instance_availability_group_name str
    Managed instance side availability group name
    instance_link_role str | LinkRole
    Managed instance side link role
    partner_availability_group_name str
    SQL server side availability group name
    partner_endpoint str
    SQL server side endpoint - IP or DNS resolvable name
    replication_mode str | ReplicationModeType
    Replication mode of the link
    seeding_mode str | SeedingModeType
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    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.
    databases List<Property Map>
    Databases in the distributed availability group
    distributedAvailabilityGroupName String
    The distributed availability group name.
    failoverMode String | "None" | "Manual"
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName String
    Managed instance side availability group name
    instanceLinkRole String | "Primary" | "Secondary"
    Managed instance side link role
    partnerAvailabilityGroupName String
    SQL server side availability group name
    partnerEndpoint String
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode String | "Async" | "Sync"
    Replication mode of the link
    seedingMode String | "Automatic" | "Manual"
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DistributedAvailabilityGroup resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    DistributedAvailabilityGroupId string
    ID of the distributed availability group
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    PartnerLinkRole string
    SQL server side link role
    Type string
    Resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    DistributedAvailabilityGroupId string
    ID of the distributed availability group
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    PartnerLinkRole string
    SQL server side link role
    Type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    distributedAvailabilityGroupId String
    ID of the distributed availability group
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    partnerLinkRole String
    SQL server side link role
    type String
    Resource type.
    azureApiVersion string
    The Azure API version of the resource.
    distributedAvailabilityGroupId string
    ID of the distributed availability group
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    partnerLinkRole string
    SQL server side link role
    type string
    Resource type.
    azure_api_version str
    The Azure API version of the resource.
    distributed_availability_group_id str
    ID of the distributed availability group
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    partner_link_role str
    SQL server side link role
    type str
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    distributedAvailabilityGroupId String
    ID of the distributed availability group
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    partnerLinkRole String
    SQL server side link role
    type String
    Resource type.

    Supporting Types

    CertificateInfoResponse, CertificateInfoResponseArgs

    CertificateName string
    The certificate name
    ExpiryDate string
    The certificate expiry date
    CertificateName string
    The certificate name
    ExpiryDate string
    The certificate expiry date
    certificateName String
    The certificate name
    expiryDate String
    The certificate expiry date
    certificateName string
    The certificate name
    expiryDate string
    The certificate expiry date
    certificate_name str
    The certificate name
    expiry_date str
    The certificate expiry date
    certificateName String
    The certificate name
    expiryDate String
    The certificate expiry date

    DistributedAvailabilityGroupDatabase, DistributedAvailabilityGroupDatabaseArgs

    DatabaseName string
    The name of the database in link
    DatabaseName string
    The name of the database in link
    databaseName String
    The name of the database in link
    databaseName string
    The name of the database in link
    database_name str
    The name of the database in link
    databaseName String
    The name of the database in link

    DistributedAvailabilityGroupDatabaseResponse, DistributedAvailabilityGroupDatabaseResponseArgs

    ConnectedState string
    Link connected state
    InstanceRedoReplicationLagSeconds int
    Redo lag when Managed Instance link side is primary
    InstanceReplicaId string
    Managed instance replica id
    InstanceSendReplicationLagSeconds int
    Replication lag when Managed Instance link side is primary
    LastBackupLsn string
    Last backup LSN
    LastBackupTime string
    Last backup LSN time
    LastCommitLsn string
    Last commit LSN
    LastCommitTime string
    Last commit LSN time
    LastHardenedLsn string
    Last hardened LSN
    LastHardenedTime string
    Last hardened LSN time
    LastReceivedLsn string
    Last received LSN
    LastReceivedTime string
    Last received LSN time
    LastSentLsn string
    Last sent LSN
    LastSentTime string
    Last sent LSN time
    MostRecentLinkError string
    The most recent link connection error description
    PartnerAuthCertValidity Pulumi.AzureNative.Sql.Inputs.CertificateInfoResponse
    SQL server certificate validity
    PartnerReplicaId string
    SQL server replica id
    ReplicaState string
    Current link state
    SeedingProgress string
    Seeding progress
    SynchronizationHealth string
    Link health state
    DatabaseName string
    The name of the database in link
    ConnectedState string
    Link connected state
    InstanceRedoReplicationLagSeconds int
    Redo lag when Managed Instance link side is primary
    InstanceReplicaId string
    Managed instance replica id
    InstanceSendReplicationLagSeconds int
    Replication lag when Managed Instance link side is primary
    LastBackupLsn string
    Last backup LSN
    LastBackupTime string
    Last backup LSN time
    LastCommitLsn string
    Last commit LSN
    LastCommitTime string
    Last commit LSN time
    LastHardenedLsn string
    Last hardened LSN
    LastHardenedTime string
    Last hardened LSN time
    LastReceivedLsn string
    Last received LSN
    LastReceivedTime string
    Last received LSN time
    LastSentLsn string
    Last sent LSN
    LastSentTime string
    Last sent LSN time
    MostRecentLinkError string
    The most recent link connection error description
    PartnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    PartnerReplicaId string
    SQL server replica id
    ReplicaState string
    Current link state
    SeedingProgress string
    Seeding progress
    SynchronizationHealth string
    Link health state
    DatabaseName string
    The name of the database in link
    connectedState String
    Link connected state
    instanceRedoReplicationLagSeconds Integer
    Redo lag when Managed Instance link side is primary
    instanceReplicaId String
    Managed instance replica id
    instanceSendReplicationLagSeconds Integer
    Replication lag when Managed Instance link side is primary
    lastBackupLsn String
    Last backup LSN
    lastBackupTime String
    Last backup LSN time
    lastCommitLsn String
    Last commit LSN
    lastCommitTime String
    Last commit LSN time
    lastHardenedLsn String
    Last hardened LSN
    lastHardenedTime String
    Last hardened LSN time
    lastReceivedLsn String
    Last received LSN
    lastReceivedTime String
    Last received LSN time
    lastSentLsn String
    Last sent LSN
    lastSentTime String
    Last sent LSN time
    mostRecentLinkError String
    The most recent link connection error description
    partnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    partnerReplicaId String
    SQL server replica id
    replicaState String
    Current link state
    seedingProgress String
    Seeding progress
    synchronizationHealth String
    Link health state
    databaseName String
    The name of the database in link
    connectedState string
    Link connected state
    instanceRedoReplicationLagSeconds number
    Redo lag when Managed Instance link side is primary
    instanceReplicaId string
    Managed instance replica id
    instanceSendReplicationLagSeconds number
    Replication lag when Managed Instance link side is primary
    lastBackupLsn string
    Last backup LSN
    lastBackupTime string
    Last backup LSN time
    lastCommitLsn string
    Last commit LSN
    lastCommitTime string
    Last commit LSN time
    lastHardenedLsn string
    Last hardened LSN
    lastHardenedTime string
    Last hardened LSN time
    lastReceivedLsn string
    Last received LSN
    lastReceivedTime string
    Last received LSN time
    lastSentLsn string
    Last sent LSN
    lastSentTime string
    Last sent LSN time
    mostRecentLinkError string
    The most recent link connection error description
    partnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    partnerReplicaId string
    SQL server replica id
    replicaState string
    Current link state
    seedingProgress string
    Seeding progress
    synchronizationHealth string
    Link health state
    databaseName string
    The name of the database in link
    connected_state str
    Link connected state
    instance_redo_replication_lag_seconds int
    Redo lag when Managed Instance link side is primary
    instance_replica_id str
    Managed instance replica id
    instance_send_replication_lag_seconds int
    Replication lag when Managed Instance link side is primary
    last_backup_lsn str
    Last backup LSN
    last_backup_time str
    Last backup LSN time
    last_commit_lsn str
    Last commit LSN
    last_commit_time str
    Last commit LSN time
    last_hardened_lsn str
    Last hardened LSN
    last_hardened_time str
    Last hardened LSN time
    last_received_lsn str
    Last received LSN
    last_received_time str
    Last received LSN time
    last_sent_lsn str
    Last sent LSN
    last_sent_time str
    Last sent LSN time
    most_recent_link_error str
    The most recent link connection error description
    partner_auth_cert_validity CertificateInfoResponse
    SQL server certificate validity
    partner_replica_id str
    SQL server replica id
    replica_state str
    Current link state
    seeding_progress str
    Seeding progress
    synchronization_health str
    Link health state
    database_name str
    The name of the database in link
    connectedState String
    Link connected state
    instanceRedoReplicationLagSeconds Number
    Redo lag when Managed Instance link side is primary
    instanceReplicaId String
    Managed instance replica id
    instanceSendReplicationLagSeconds Number
    Replication lag when Managed Instance link side is primary
    lastBackupLsn String
    Last backup LSN
    lastBackupTime String
    Last backup LSN time
    lastCommitLsn String
    Last commit LSN
    lastCommitTime String
    Last commit LSN time
    lastHardenedLsn String
    Last hardened LSN
    lastHardenedTime String
    Last hardened LSN time
    lastReceivedLsn String
    Last received LSN
    lastReceivedTime String
    Last received LSN time
    lastSentLsn String
    Last sent LSN
    lastSentTime String
    Last sent LSN time
    mostRecentLinkError String
    The most recent link connection error description
    partnerAuthCertValidity Property Map
    SQL server certificate validity
    partnerReplicaId String
    SQL server replica id
    replicaState String
    Current link state
    seedingProgress String
    Seeding progress
    synchronizationHealth String
    Link health state
    databaseName String
    The name of the database in link

    FailoverModeType, FailoverModeTypeArgs

    None
    None
    Manual
    Manual
    FailoverModeTypeNone
    None
    FailoverModeTypeManual
    Manual
    None
    None
    Manual
    Manual
    None
    None
    Manual
    Manual
    NONE
    None
    MANUAL
    Manual
    "None"
    None
    "Manual"
    Manual

    LinkRole, LinkRoleArgs

    Primary
    Primary
    Secondary
    Secondary
    LinkRolePrimary
    Primary
    LinkRoleSecondary
    Secondary
    Primary
    Primary
    Secondary
    Secondary
    Primary
    Primary
    Secondary
    Secondary
    PRIMARY
    Primary
    SECONDARY
    Secondary
    "Primary"
    Primary
    "Secondary"
    Secondary

    ReplicationModeType, ReplicationModeTypeArgs

    Async
    Async
    Sync
    Sync
    ReplicationModeTypeAsync
    Async
    ReplicationModeTypeSync
    Sync
    Async
    Async
    Sync
    Sync
    Async
    Async
    Sync
    Sync
    ASYNC_
    Async
    SYNC
    Sync
    "Async"
    Async
    "Sync"
    Sync

    SeedingModeType, SeedingModeTypeArgs

    Automatic
    Automatic
    Manual
    Manual
    SeedingModeTypeAutomatic
    Automatic
    SeedingModeTypeManual
    Manual
    Automatic
    Automatic
    Manual
    Manual
    Automatic
    Automatic
    Manual
    Manual
    AUTOMATIC
    Automatic
    MANUAL
    Manual
    "Automatic"
    Automatic
    "Manual"
    Manual

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:sql:DistributedAvailabilityGroup dag /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi