InstanceFailoverGroupArgs

data class InstanceFailoverGroupArgs(val failoverGroupName: Output<String>? = null, val locationName: Output<String>? = null, val managedInstancePairs: Output<List<ManagedInstancePairInfoArgs>>? = null, val partnerRegions: Output<List<PartnerRegionInfoArgs>>? = null, val readOnlyEndpoint: Output<InstanceFailoverGroupReadOnlyEndpointArgs>? = null, val readWriteEndpoint: Output<InstanceFailoverGroupReadWriteEndpointArgs>? = null, val resourceGroupName: Output<String>? = null, val secondaryType: Output<Either<String, SecondaryInstanceType>>? = null) : ConvertibleToJava<InstanceFailoverGroupArgs>

An instance failover group. 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: 2017-10-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 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 failover group

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var instanceFailoverGroup = new AzureNative.Sql.InstanceFailoverGroup("instanceFailoverGroup", new()
{
FailoverGroupName = "failover-group-test-3",
LocationName = "Japan East",
ManagedInstancePairs = new[]
{
new AzureNative.Sql.Inputs.ManagedInstancePairInfoArgs
{
PartnerManagedInstanceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
PrimaryManagedInstanceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
},
},
PartnerRegions = new[]
{
new AzureNative.Sql.Inputs.PartnerRegionInfoArgs
{
Location = "Japan West",
},
},
ReadOnlyEndpoint = new AzureNative.Sql.Inputs.InstanceFailoverGroupReadOnlyEndpointArgs
{
FailoverPolicy = AzureNative.Sql.ReadOnlyEndpointFailoverPolicy.Disabled,
},
ReadWriteEndpoint = new AzureNative.Sql.Inputs.InstanceFailoverGroupReadWriteEndpointArgs
{
FailoverPolicy = AzureNative.Sql.ReadWriteEndpointFailoverPolicy.Automatic,
FailoverWithDataLossGracePeriodMinutes = 480,
},
ResourceGroupName = "Default",
SecondaryType = AzureNative.Sql.SecondaryInstanceType.Geo,
});
});
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.NewInstanceFailoverGroup(ctx, "instanceFailoverGroup", &sql.InstanceFailoverGroupArgs{
FailoverGroupName: pulumi.String("failover-group-test-3"),
LocationName: pulumi.String("Japan East"),
ManagedInstancePairs: sql.ManagedInstancePairInfoArray{
&sql.ManagedInstancePairInfoArgs{
PartnerManagedInstanceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"),
PrimaryManagedInstanceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"),
},
},
PartnerRegions: sql.PartnerRegionInfoArray{
&sql.PartnerRegionInfoArgs{
Location: pulumi.String("Japan West"),
},
},
ReadOnlyEndpoint: &sql.InstanceFailoverGroupReadOnlyEndpointArgs{
FailoverPolicy: pulumi.String(sql.ReadOnlyEndpointFailoverPolicyDisabled),
},
ReadWriteEndpoint: &sql.InstanceFailoverGroupReadWriteEndpointArgs{
FailoverPolicy: pulumi.String(sql.ReadWriteEndpointFailoverPolicyAutomatic),
FailoverWithDataLossGracePeriodMinutes: pulumi.Int(480),
},
ResourceGroupName: pulumi.String("Default"),
SecondaryType: pulumi.String(sql.SecondaryInstanceTypeGeo),
})
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.InstanceFailoverGroup;
import com.pulumi.azurenative.sql.InstanceFailoverGroupArgs;
import com.pulumi.azurenative.sql.inputs.ManagedInstancePairInfoArgs;
import com.pulumi.azurenative.sql.inputs.PartnerRegionInfoArgs;
import com.pulumi.azurenative.sql.inputs.InstanceFailoverGroupReadOnlyEndpointArgs;
import com.pulumi.azurenative.sql.inputs.InstanceFailoverGroupReadWriteEndpointArgs;
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 instanceFailoverGroup = new InstanceFailoverGroup("instanceFailoverGroup", InstanceFailoverGroupArgs.builder()
.failoverGroupName("failover-group-test-3")
.locationName("Japan East")
.managedInstancePairs(ManagedInstancePairInfoArgs.builder()
.partnerManagedInstanceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance")
.primaryManagedInstanceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance")
.build())
.partnerRegions(PartnerRegionInfoArgs.builder()
.location("Japan West")
.build())
.readOnlyEndpoint(InstanceFailoverGroupReadOnlyEndpointArgs.builder()
.failoverPolicy("Disabled")
.build())
.readWriteEndpoint(InstanceFailoverGroupReadWriteEndpointArgs.builder()
.failoverPolicy("Automatic")
.failoverWithDataLossGracePeriodMinutes(480)
.build())
.resourceGroupName("Default")
.secondaryType("Geo")
.build());
}
}

Import

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

$ pulumi import azure-native:sql:InstanceFailoverGroup failover-group-test-3 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}

Constructors

Link copied to clipboard
constructor(failoverGroupName: Output<String>? = null, locationName: Output<String>? = null, managedInstancePairs: Output<List<ManagedInstancePairInfoArgs>>? = null, partnerRegions: Output<List<PartnerRegionInfoArgs>>? = null, readOnlyEndpoint: Output<InstanceFailoverGroupReadOnlyEndpointArgs>? = null, readWriteEndpoint: Output<InstanceFailoverGroupReadWriteEndpointArgs>? = null, resourceGroupName: Output<String>? = null, secondaryType: Output<Either<String, SecondaryInstanceType>>? = null)

Properties

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

The name of the failover group.

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

The name of the region where the resource is located.

Link copied to clipboard

List of managed instance pairs in the failover group.

Link copied to clipboard

Partner region information for the failover group.

Link copied to clipboard

Read-only endpoint of the failover group instance.

Link copied to clipboard

Read-write endpoint of the failover group instance.

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 secondaryType: Output<Either<String, SecondaryInstanceType>>? = null

Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.

Functions

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