DistributedAvailabilityGroupArgs

data class DistributedAvailabilityGroupArgs(val databases: Output<List<DistributedAvailabilityGroupDatabaseArgs>>? = null, val distributedAvailabilityGroupName: Output<String>? = null, val failoverMode: Output<Either<String, FailoverModeType>>? = null, val instanceAvailabilityGroupName: Output<String>? = null, val instanceLinkRole: Output<Either<String, LinkRole>>? = null, val managedInstanceName: Output<String>? = null, val partnerAvailabilityGroupName: Output<String>? = null, val partnerEndpoint: Output<String>? = null, val replicationMode: Output<Either<String, ReplicationModeType>>? = null, val resourceGroupName: Output<String>? = null, val seedingMode: Output<Either<String, SeedingModeType>>? = null) : ConvertibleToJava<DistributedAvailabilityGroupArgs>

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/#accessing-any-api-version-via-local-packages 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());
}
}

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

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}

Constructors

Link copied to clipboard
constructor(databases: Output<List<DistributedAvailabilityGroupDatabaseArgs>>? = null, distributedAvailabilityGroupName: Output<String>? = null, failoverMode: Output<Either<String, FailoverModeType>>? = null, instanceAvailabilityGroupName: Output<String>? = null, instanceLinkRole: Output<Either<String, LinkRole>>? = null, managedInstanceName: Output<String>? = null, partnerAvailabilityGroupName: Output<String>? = null, partnerEndpoint: Output<String>? = null, replicationMode: Output<Either<String, ReplicationModeType>>? = null, resourceGroupName: Output<String>? = null, seedingMode: Output<Either<String, SeedingModeType>>? = null)

Properties

Link copied to clipboard

Databases in the distributed availability group

Link copied to clipboard

The distributed availability group name.

Link copied to clipboard
val failoverMode: Output<Either<String, FailoverModeType>>? = null

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.

Link copied to clipboard

Managed instance side availability group name

Link copied to clipboard
val instanceLinkRole: Output<Either<String, LinkRole>>? = null

Managed instance side link role

Link copied to clipboard
val managedInstanceName: Output<String>? = null

The name of the managed instance.

Link copied to clipboard

SQL server side availability group name

Link copied to clipboard
val partnerEndpoint: Output<String>? = null

SQL server side endpoint - IP or DNS resolvable name

Link copied to clipboard
val replicationMode: Output<Either<String, ReplicationModeType>>? = null

Replication mode of the link

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Link copied to clipboard
val seedingMode: Output<Either<String, SeedingModeType>>? = null

Database seeding mode – can be Automatic (default), or Manual for supported scenarios.

Functions

Link copied to clipboard
open override fun toJava(): DistributedAvailabilityGroupArgs