Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. FailoverGroup
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.FailoverGroup

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    A 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: 2015-05-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 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 failoverGroup = new AzureNative.Sql.FailoverGroup("failoverGroup", new()
    {
        Databases = new[]
        {
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
        },
        FailoverGroupName = "failover-group-test-3",
        PartnerServers = new[]
        {
            new AzureNative.Sql.Inputs.PartnerInfoArgs
            {
                Id = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            },
        },
        ReadOnlyEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadOnlyEndpointArgs
        {
            FailoverPolicy = AzureNative.Sql.ReadOnlyEndpointFailoverPolicy.Disabled,
        },
        ReadWriteEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadWriteEndpointArgs
        {
            FailoverPolicy = AzureNative.Sql.ReadWriteEndpointFailoverPolicy.Automatic,
            FailoverWithDataLossGracePeriodMinutes = 480,
        },
        ResourceGroupName = "Default",
        ServerName = "failover-group-primary-server",
    });

});

    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.NewFailoverGroup(ctx, "failoverGroup", &sql.FailoverGroupArgs{
			Databases: pulumi.StringArray{
				pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"),
				pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"),
			},
			FailoverGroupName: pulumi.String("failover-group-test-3"),
			PartnerServers: sql.PartnerInfoArray{
				&sql.PartnerInfoArgs{
					Id: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"),
				},
			},
			ReadOnlyEndpoint: &sql.FailoverGroupReadOnlyEndpointArgs{
				FailoverPolicy: pulumi.String(sql.ReadOnlyEndpointFailoverPolicyDisabled),
			},
			ReadWriteEndpoint: &sql.FailoverGroupReadWriteEndpointArgs{
				FailoverPolicy:                         pulumi.String(sql.ReadWriteEndpointFailoverPolicyAutomatic),
				FailoverWithDataLossGracePeriodMinutes: pulumi.Int(480),
			},
			ResourceGroupName: pulumi.String("Default"),
			ServerName:        pulumi.String("failover-group-primary-server"),
		})
		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.FailoverGroup;
import com.pulumi.azurenative.sql.FailoverGroupArgs;
import com.pulumi.azurenative.sql.inputs.PartnerInfoArgs;
import com.pulumi.azurenative.sql.inputs.FailoverGroupReadOnlyEndpointArgs;
import com.pulumi.azurenative.sql.inputs.FailoverGroupReadWriteEndpointArgs;
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 failoverGroup = new FailoverGroup("failoverGroup", FailoverGroupArgs.builder()
            .databases(            
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2")
            .failoverGroupName("failover-group-test-3")
            .partnerServers(PartnerInfoArgs.builder()
                .id("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server")
                .build())
            .readOnlyEndpoint(FailoverGroupReadOnlyEndpointArgs.builder()
                .failoverPolicy("Disabled")
                .build())
            .readWriteEndpoint(FailoverGroupReadWriteEndpointArgs.builder()
                .failoverPolicy("Automatic")
                .failoverWithDataLossGracePeriodMinutes(480)
                .build())
            .resourceGroupName("Default")
            .serverName("failover-group-primary-server")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const failoverGroup = new azure_native.sql.FailoverGroup("failoverGroup", {
    databases: [
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
    ],
    failoverGroupName: "failover-group-test-3",
    partnerServers: [{
        id: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
    }],
    readOnlyEndpoint: {
        failoverPolicy: azure_native.sql.ReadOnlyEndpointFailoverPolicy.Disabled,
    },
    readWriteEndpoint: {
        failoverPolicy: azure_native.sql.ReadWriteEndpointFailoverPolicy.Automatic,
        failoverWithDataLossGracePeriodMinutes: 480,
    },
    resourceGroupName: "Default",
    serverName: "failover-group-primary-server",
});

    import pulumi
import pulumi_azure_native as azure_native

failover_group = azure_native.sql.FailoverGroup("failoverGroup",
    databases=[
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
    ],
    failover_group_name="failover-group-test-3",
    partner_servers=[{
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
    }],
    read_only_endpoint={
        "failover_policy": azure_native.sql.ReadOnlyEndpointFailoverPolicy.DISABLED,
    },
    read_write_endpoint={
        "failover_policy": azure_native.sql.ReadWriteEndpointFailoverPolicy.AUTOMATIC,
        "failover_with_data_loss_grace_period_minutes": 480,
    },
    resource_group_name="Default",
    server_name="failover-group-primary-server")

    resources:
  failoverGroup:
    type: azure-native:sql:FailoverGroup
    properties:
      databases:
        - /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1
        - /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2
      failoverGroupName: failover-group-test-3
      partnerServers:
        - id: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server
      readOnlyEndpoint:
        failoverPolicy: Disabled
      readWriteEndpoint:
        failoverPolicy: Automatic
        failoverWithDataLossGracePeriodMinutes: 480
      resourceGroupName: Default
      serverName: failover-group-primary-server

    Create failover group with standby secondary database on partner server.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var failoverGroup = new AzureNative.Sql.FailoverGroup("failoverGroup", new()
    {
        Databases = new[]
        {
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
        },
        FailoverGroupName = "failover-group-test-3",
        PartnerServers = new[]
        {
            new AzureNative.Sql.Inputs.PartnerInfoArgs
            {
                Id = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            },
        },
        ReadOnlyEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadOnlyEndpointArgs
        {
            FailoverPolicy = AzureNative.Sql.ReadOnlyEndpointFailoverPolicy.Disabled,
        },
        ReadWriteEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadWriteEndpointArgs
        {
            FailoverPolicy = AzureNative.Sql.ReadWriteEndpointFailoverPolicy.Automatic,
            FailoverWithDataLossGracePeriodMinutes = 480,
        },
        ResourceGroupName = "Default",
        SecondaryType = AzureNative.Sql.FailoverGroupDatabasesSecondaryType.Standby,
        ServerName = "failover-group-primary-server",
    });

});

    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.NewFailoverGroup(ctx, "failoverGroup", &sql.FailoverGroupArgs{
			Databases: pulumi.StringArray{
				pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"),
				pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"),
			},
			FailoverGroupName: pulumi.String("failover-group-test-3"),
			PartnerServers: sql.PartnerInfoArray{
				&sql.PartnerInfoArgs{
					Id: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"),
				},
			},
			ReadOnlyEndpoint: &sql.FailoverGroupReadOnlyEndpointArgs{
				FailoverPolicy: pulumi.String(sql.ReadOnlyEndpointFailoverPolicyDisabled),
			},
			ReadWriteEndpoint: &sql.FailoverGroupReadWriteEndpointArgs{
				FailoverPolicy:                         pulumi.String(sql.ReadWriteEndpointFailoverPolicyAutomatic),
				FailoverWithDataLossGracePeriodMinutes: pulumi.Int(480),
			},
			ResourceGroupName: pulumi.String("Default"),
			SecondaryType:     pulumi.String(sql.FailoverGroupDatabasesSecondaryTypeStandby),
			ServerName:        pulumi.String("failover-group-primary-server"),
		})
		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.FailoverGroup;
import com.pulumi.azurenative.sql.FailoverGroupArgs;
import com.pulumi.azurenative.sql.inputs.PartnerInfoArgs;
import com.pulumi.azurenative.sql.inputs.FailoverGroupReadOnlyEndpointArgs;
import com.pulumi.azurenative.sql.inputs.FailoverGroupReadWriteEndpointArgs;
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 failoverGroup = new FailoverGroup("failoverGroup", FailoverGroupArgs.builder()
            .databases(            
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2")
            .failoverGroupName("failover-group-test-3")
            .partnerServers(PartnerInfoArgs.builder()
                .id("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server")
                .build())
            .readOnlyEndpoint(FailoverGroupReadOnlyEndpointArgs.builder()
                .failoverPolicy("Disabled")
                .build())
            .readWriteEndpoint(FailoverGroupReadWriteEndpointArgs.builder()
                .failoverPolicy("Automatic")
                .failoverWithDataLossGracePeriodMinutes(480)
                .build())
            .resourceGroupName("Default")
            .secondaryType("Standby")
            .serverName("failover-group-primary-server")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const failoverGroup = new azure_native.sql.FailoverGroup("failoverGroup", {
    databases: [
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
    ],
    failoverGroupName: "failover-group-test-3",
    partnerServers: [{
        id: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
    }],
    readOnlyEndpoint: {
        failoverPolicy: azure_native.sql.ReadOnlyEndpointFailoverPolicy.Disabled,
    },
    readWriteEndpoint: {
        failoverPolicy: azure_native.sql.ReadWriteEndpointFailoverPolicy.Automatic,
        failoverWithDataLossGracePeriodMinutes: 480,
    },
    resourceGroupName: "Default",
    secondaryType: azure_native.sql.FailoverGroupDatabasesSecondaryType.Standby,
    serverName: "failover-group-primary-server",
});

    import pulumi
import pulumi_azure_native as azure_native

failover_group = azure_native.sql.FailoverGroup("failoverGroup",
    databases=[
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2",
    ],
    failover_group_name="failover-group-test-3",
    partner_servers=[{
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
    }],
    read_only_endpoint={
        "failover_policy": azure_native.sql.ReadOnlyEndpointFailoverPolicy.DISABLED,
    },
    read_write_endpoint={
        "failover_policy": azure_native.sql.ReadWriteEndpointFailoverPolicy.AUTOMATIC,
        "failover_with_data_loss_grace_period_minutes": 480,
    },
    resource_group_name="Default",
    secondary_type=azure_native.sql.FailoverGroupDatabasesSecondaryType.STANDBY,
    server_name="failover-group-primary-server")

    resources:
  failoverGroup:
    type: azure-native:sql:FailoverGroup
    properties:
      databases:
        - /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1
        - /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2
      failoverGroupName: failover-group-test-3
      partnerServers:
        - id: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server
      readOnlyEndpoint:
        failoverPolicy: Disabled
      readWriteEndpoint:
        failoverPolicy: Automatic
        failoverWithDataLossGracePeriodMinutes: 480
      resourceGroupName: Default
      secondaryType: Standby
      serverName: failover-group-primary-server

    Create FailoverGroup Resource

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

    Constructor syntax

    new FailoverGroup(name: string, args: FailoverGroupArgs, opts?: CustomResourceOptions);
    @overload
def FailoverGroup(resource_name: str,
                  args: FailoverGroupArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def FailoverGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  partner_servers: Optional[Sequence[PartnerInfoArgs]] = None,
                  read_write_endpoint: Optional[FailoverGroupReadWriteEndpointArgs] = None,
                  resource_group_name: Optional[str] = None,
                  server_name: Optional[str] = None,
                  databases: Optional[Sequence[str]] = None,
                  failover_group_name: Optional[str] = None,
                  read_only_endpoint: Optional[FailoverGroupReadOnlyEndpointArgs] = None,
                  secondary_type: Optional[Union[str, FailoverGroupDatabasesSecondaryType]] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewFailoverGroup(ctx *Context, name string, args FailoverGroupArgs, opts ...ResourceOption) (*FailoverGroup, error)
    public FailoverGroup(string name, FailoverGroupArgs args, CustomResourceOptions? opts = null)
    public FailoverGroup(String name, FailoverGroupArgs args)
public FailoverGroup(String name, FailoverGroupArgs args, CustomResourceOptions options)

    type: azure-native:sql:FailoverGroup
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 FailoverGroupArgs
    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 FailoverGroupArgs
    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 FailoverGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FailoverGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FailoverGroupArgs
    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 azure_nativeFailoverGroupResource = new AzureNative.Sql.FailoverGroup("azure-nativeFailoverGroupResource", new()
{
    PartnerServers = new[]
    {
        new AzureNative.Sql.Inputs.PartnerInfoArgs
        {
            Id = "string",
        },
    },
    ReadWriteEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadWriteEndpointArgs
    {
        FailoverPolicy = "string",
        FailoverWithDataLossGracePeriodMinutes = 0,
    },
    ResourceGroupName = "string",
    ServerName = "string",
    Databases = new[]
    {
        "string",
    },
    FailoverGroupName = "string",
    ReadOnlyEndpoint = new AzureNative.Sql.Inputs.FailoverGroupReadOnlyEndpointArgs
    {
        FailoverPolicy = "string",
        TargetServer = "string",
    },
    SecondaryType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sql.NewFailoverGroup(ctx, "azure-nativeFailoverGroupResource", &sql.FailoverGroupArgs{
	PartnerServers: sql.PartnerInfoArray{
		&sql.PartnerInfoArgs{
			Id: pulumi.String("string"),
		},
	},
	ReadWriteEndpoint: &sql.FailoverGroupReadWriteEndpointArgs{
		FailoverPolicy:                         pulumi.String("string"),
		FailoverWithDataLossGracePeriodMinutes: pulumi.Int(0),
	},
	ResourceGroupName: pulumi.String("string"),
	ServerName:        pulumi.String("string"),
	Databases: pulumi.StringArray{
		pulumi.String("string"),
	},
	FailoverGroupName: pulumi.String("string"),
	ReadOnlyEndpoint: &sql.FailoverGroupReadOnlyEndpointArgs{
		FailoverPolicy: pulumi.String("string"),
		TargetServer:   pulumi.String("string"),
	},
	SecondaryType: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azure_nativeFailoverGroupResource = new FailoverGroup("azure-nativeFailoverGroupResource", FailoverGroupArgs.builder()
    .partnerServers(PartnerInfoArgs.builder()
        .id("string")
        .build())
    .readWriteEndpoint(FailoverGroupReadWriteEndpointArgs.builder()
        .failoverPolicy("string")
        .failoverWithDataLossGracePeriodMinutes(0)
        .build())
    .resourceGroupName("string")
    .serverName("string")
    .databases("string")
    .failoverGroupName("string")
    .readOnlyEndpoint(FailoverGroupReadOnlyEndpointArgs.builder()
        .failoverPolicy("string")
        .targetServer("string")
        .build())
    .secondaryType("string")
    .tags(Map.of("string", "string"))
    .build());

    azure_native_failover_group_resource = azure_native.sql.FailoverGroup("azure-nativeFailoverGroupResource",
    partner_servers=[{
        "id": "string",
    }],
    read_write_endpoint={
        "failover_policy": "string",
        "failover_with_data_loss_grace_period_minutes": 0,
    },
    resource_group_name="string",
    server_name="string",
    databases=["string"],
    failover_group_name="string",
    read_only_endpoint={
        "failover_policy": "string",
        "target_server": "string",
    },
    secondary_type="string",
    tags={
        "string": "string",
    })

    const azure_nativeFailoverGroupResource = new azure_native.sql.FailoverGroup("azure-nativeFailoverGroupResource", {
    partnerServers: [{
        id: "string",
    }],
    readWriteEndpoint: {
        failoverPolicy: "string",
        failoverWithDataLossGracePeriodMinutes: 0,
    },
    resourceGroupName: "string",
    serverName: "string",
    databases: ["string"],
    failoverGroupName: "string",
    readOnlyEndpoint: {
        failoverPolicy: "string",
        targetServer: "string",
    },
    secondaryType: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:sql:FailoverGroup
properties:
    databases:
        - string
    failoverGroupName: string
    partnerServers:
        - id: string
    readOnlyEndpoint:
        failoverPolicy: string
        targetServer: string
    readWriteEndpoint:
        failoverPolicy: string
        failoverWithDataLossGracePeriodMinutes: 0
    resourceGroupName: string
    secondaryType: string
    serverName: string
    tags:
        string: string

    FailoverGroup 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 FailoverGroup resource accepts the following input properties:

    PartnerServers List<Pulumi.AzureNative.Sql.Inputs.PartnerInfo>
    List of partner server information for the failover group.
    ReadWriteEndpoint Pulumi.AzureNative.Sql.Inputs.FailoverGroupReadWriteEndpoint
    Read-write endpoint of the failover group 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.
    ServerName string
    The name of the server containing the failover group.
    Databases List<string>
    List of databases in the failover group.
    FailoverGroupName string
    The name of the failover group.
    ReadOnlyEndpoint Pulumi.AzureNative.Sql.Inputs.FailoverGroupReadOnlyEndpoint
    Read-only endpoint of the failover group instance.
    SecondaryType string | Pulumi.AzureNative.Sql.FailoverGroupDatabasesSecondaryType
    Databases secondary type on partner server.
    Tags Dictionary<string, string>
    Resource tags.
    PartnerServers []PartnerInfoArgs
    List of partner server information for the failover group.
    ReadWriteEndpoint FailoverGroupReadWriteEndpointArgs
    Read-write endpoint of the failover group 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.
    ServerName string
    The name of the server containing the failover group.
    Databases []string
    List of databases in the failover group.
    FailoverGroupName string
    The name of the failover group.
    ReadOnlyEndpoint FailoverGroupReadOnlyEndpointArgs
    Read-only endpoint of the failover group instance.
    SecondaryType string | FailoverGroupDatabasesSecondaryType
    Databases secondary type on partner server.
    Tags map[string]string
    Resource tags.
    partnerServers List<PartnerInfo>
    List of partner server information for the failover group.
    readWriteEndpoint FailoverGroupReadWriteEndpoint
    Read-write endpoint of the failover group 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.
    serverName String
    The name of the server containing the failover group.
    databases List<String>
    List of databases in the failover group.
    failoverGroupName String
    The name of the failover group.
    readOnlyEndpoint FailoverGroupReadOnlyEndpoint
    Read-only endpoint of the failover group instance.
    secondaryType String | FailoverGroupDatabasesSecondaryType
    Databases secondary type on partner server.
    tags Map<String,String>
    Resource tags.
    partnerServers PartnerInfo[]
    List of partner server information for the failover group.
    readWriteEndpoint FailoverGroupReadWriteEndpoint
    Read-write endpoint of the failover group 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.
    serverName string
    The name of the server containing the failover group.
    databases string[]
    List of databases in the failover group.
    failoverGroupName string
    The name of the failover group.
    readOnlyEndpoint FailoverGroupReadOnlyEndpoint
    Read-only endpoint of the failover group instance.
    secondaryType string | FailoverGroupDatabasesSecondaryType
    Databases secondary type on partner server.
    tags {[key: string]: string}
    Resource tags.
    partner_servers Sequence[PartnerInfoArgs]
    List of partner server information for the failover group.
    read_write_endpoint FailoverGroupReadWriteEndpointArgs
    Read-write endpoint of the failover group 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.
    server_name str
    The name of the server containing the failover group.
    databases Sequence[str]
    List of databases in the failover group.
    failover_group_name str
    The name of the failover group.
    read_only_endpoint FailoverGroupReadOnlyEndpointArgs
    Read-only endpoint of the failover group instance.
    secondary_type str | FailoverGroupDatabasesSecondaryType
    Databases secondary type on partner server.
    tags Mapping[str, str]
    Resource tags.
    partnerServers List<Property Map>
    List of partner server information for the failover group.
    readWriteEndpoint Property Map
    Read-write endpoint of the failover group 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.
    serverName String
    The name of the server containing the failover group.
    databases List<String>
    List of databases in the failover group.
    failoverGroupName String
    The name of the failover group.
    readOnlyEndpoint Property Map
    Read-only endpoint of the failover group instance.
    secondaryType String | "Geo" | "Standby"
    Databases secondary type on partner server.
    tags Map<String>
    Resource tags.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Resource location.
    Name string
    Resource name.
    ReplicationRole string
    Local replication role of the failover group instance.
    ReplicationState string
    Replication state of the failover group instance.
    Type string
    Resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Resource location.
    Name string
    Resource name.
    ReplicationRole string
    Local replication role of the failover group instance.
    ReplicationState string
    Replication state of the failover group instance.
    Type string
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Resource location.
    name String
    Resource name.
    replicationRole String
    Local replication role of the failover group instance.
    replicationState String
    Replication state of the failover group instance.
    type String
    Resource type.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    Resource location.
    name string
    Resource name.
    replicationRole string
    Local replication role of the failover group instance.
    replicationState string
    Replication state of the failover group instance.
    type string
    Resource type.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    Resource location.
    name str
    Resource name.
    replication_role str
    Local replication role of the failover group instance.
    replication_state str
    Replication state of the failover group instance.
    type str
    Resource type.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Resource location.
    name String
    Resource name.
    replicationRole String
    Local replication role of the failover group instance.
    replicationState String
    Replication state of the failover group instance.
    type String
    Resource type.

    Supporting Types

    FailoverGroupDatabasesSecondaryType, FailoverGroupDatabasesSecondaryTypeArgs

    Geo
    Geo
    Standby
    Standby
    FailoverGroupDatabasesSecondaryTypeGeo
    Geo
    FailoverGroupDatabasesSecondaryTypeStandby
    Standby
    Geo
    Geo
    Standby
    Standby
    Geo
    Geo
    Standby
    Standby
    GEO
    Geo
    STANDBY
    Standby
    "Geo"
    Geo
    "Standby"
    Standby

    FailoverGroupReadOnlyEndpoint, FailoverGroupReadOnlyEndpointArgs

    FailoverPolicy string | Pulumi.AzureNative.Sql.ReadOnlyEndpointFailoverPolicy
    Failover policy of the read-only endpoint for the failover group.
    TargetServer string
    The target partner server where the read-only endpoint points to.
    FailoverPolicy string | ReadOnlyEndpointFailoverPolicy
    Failover policy of the read-only endpoint for the failover group.
    TargetServer string
    The target partner server where the read-only endpoint points to.
    failoverPolicy String | ReadOnlyEndpointFailoverPolicy
    Failover policy of the read-only endpoint for the failover group.
    targetServer String
    The target partner server where the read-only endpoint points to.
    failoverPolicy string | ReadOnlyEndpointFailoverPolicy
    Failover policy of the read-only endpoint for the failover group.
    targetServer string
    The target partner server where the read-only endpoint points to.
    failover_policy str | ReadOnlyEndpointFailoverPolicy
    Failover policy of the read-only endpoint for the failover group.
    target_server str
    The target partner server where the read-only endpoint points to.
    failoverPolicy String | "Disabled" | "Enabled"
    Failover policy of the read-only endpoint for the failover group.
    targetServer String
    The target partner server where the read-only endpoint points to.

    FailoverGroupReadOnlyEndpointResponse, FailoverGroupReadOnlyEndpointResponseArgs

    FailoverPolicy string
    Failover policy of the read-only endpoint for the failover group.
    TargetServer string
    The target partner server where the read-only endpoint points to.
    FailoverPolicy string
    Failover policy of the read-only endpoint for the failover group.
    TargetServer string
    The target partner server where the read-only endpoint points to.
    failoverPolicy String
    Failover policy of the read-only endpoint for the failover group.
    targetServer String
    The target partner server where the read-only endpoint points to.
    failoverPolicy string
    Failover policy of the read-only endpoint for the failover group.
    targetServer string
    The target partner server where the read-only endpoint points to.
    failover_policy str
    Failover policy of the read-only endpoint for the failover group.
    target_server str
    The target partner server where the read-only endpoint points to.
    failoverPolicy String
    Failover policy of the read-only endpoint for the failover group.
    targetServer String
    The target partner server where the read-only endpoint points to.

    FailoverGroupReadWriteEndpoint, FailoverGroupReadWriteEndpointArgs

    FailoverPolicy string | Pulumi.AzureNative.Sql.ReadWriteEndpointFailoverPolicy
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverWithDataLossGracePeriodMinutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverPolicy string | ReadWriteEndpointFailoverPolicy
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverWithDataLossGracePeriodMinutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy String | ReadWriteEndpointFailoverPolicy
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes Integer
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy string | ReadWriteEndpointFailoverPolicy
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes number
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failover_policy str | ReadWriteEndpointFailoverPolicy
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failover_with_data_loss_grace_period_minutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy String | "Manual" | "Automatic"
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes Number
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    FailoverGroupReadWriteEndpointResponse, FailoverGroupReadWriteEndpointResponseArgs

    FailoverPolicy string
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverWithDataLossGracePeriodMinutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverPolicy string
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    FailoverWithDataLossGracePeriodMinutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy String
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes Integer
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy string
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes number
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failover_policy str
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failover_with_data_loss_grace_period_minutes int
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverPolicy String
    Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
    failoverWithDataLossGracePeriodMinutes Number
    Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

    PartnerInfo, PartnerInfoArgs

    Id string
    Resource identifier of the partner server.
    Id string
    Resource identifier of the partner server.
    id String
    Resource identifier of the partner server.
    id string
    Resource identifier of the partner server.
    id str
    Resource identifier of the partner server.
    id String
    Resource identifier of the partner server.

    PartnerInfoResponse, PartnerInfoResponseArgs

    Id string
    Resource identifier of the partner server.
    Location string
    Geo location of the partner server.
    ReplicationRole string
    Replication role of the partner server.
    Id string
    Resource identifier of the partner server.
    Location string
    Geo location of the partner server.
    ReplicationRole string
    Replication role of the partner server.
    id String
    Resource identifier of the partner server.
    location String
    Geo location of the partner server.
    replicationRole String
    Replication role of the partner server.
    id string
    Resource identifier of the partner server.
    location string
    Geo location of the partner server.
    replicationRole string
    Replication role of the partner server.
    id str
    Resource identifier of the partner server.
    location str
    Geo location of the partner server.
    replication_role str
    Replication role of the partner server.
    id String
    Resource identifier of the partner server.
    location String
    Geo location of the partner server.
    replicationRole String
    Replication role of the partner server.

    ReadOnlyEndpointFailoverPolicy, ReadOnlyEndpointFailoverPolicyArgs

    Disabled
    Disabled
    Enabled
    Enabled
    ReadOnlyEndpointFailoverPolicyDisabled
    Disabled
    ReadOnlyEndpointFailoverPolicyEnabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    DISABLED
    Disabled
    ENABLED
    Enabled
    "Disabled"
    Disabled
    "Enabled"
    Enabled

    ReadWriteEndpointFailoverPolicy, ReadWriteEndpointFailoverPolicyArgs

    Manual
    Manual
    Automatic
    Automatic
    ReadWriteEndpointFailoverPolicyManual
    Manual
    ReadWriteEndpointFailoverPolicyAutomatic
    Automatic
    Manual
    Manual
    Automatic
    Automatic
    Manual
    Manual
    Automatic
    Automatic
    MANUAL
    Manual
    AUTOMATIC
    Automatic
    "Manual"
    Manual
    "Automatic"
    Automatic

    Import

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

    $ pulumi import azure-native:sql:FailoverGroup failover-group-test-3 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}

    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.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native