FailoverGroup

Create a failover group of databases on a collection of Azure SQL servers.

Create a FailoverGroup Resource

new FailoverGroup(name: string, args: FailoverGroupArgs, opts?: CustomResourceOptions);

def FailoverGroup(resource_name, opts=None, databases=None, name=None, partner_servers=None, read_write_endpoint_failover_policy=None, readonly_endpoint_failover_policy=None, resource_group_name=None, server_name=None, tags=None, __props__=None);

func NewFailoverGroup(ctx *Context, name string, args FailoverGroupArgs, opts ...ResourceOption) (*FailoverGroup, error)

public FailoverGroup(string name, FailoverGroupArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

FailoverGroup Resource Properties

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

Inputs

The FailoverGroup resource accepts the following input properties:

PartnerServers List<FailoverGroupPartnerServerArgs>: A list of secondary servers as documented below
ReadWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicyArgs: A read/write policy as documented below
ResourceGroupName string: The name of the resource group containing the SQL server
ServerName string: The name of the primary SQL server. Changing this forces a new resource to be created.
Databases List<string>: A list of database ids to add to the failover group
Name string: The name of the failover group. Changing this forces a new resource to be created.
ReadonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicyArgs: a read-only policy as documented below
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

PartnerServers []FailoverGroupPartnerServer: A list of secondary servers as documented below
ReadWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicy: A read/write policy as documented below
ResourceGroupName string: The name of the resource group containing the SQL server
ServerName string: The name of the primary SQL server. Changing this forces a new resource to be created.
Databases []string: A list of database ids to add to the failover group
Name string: The name of the failover group. Changing this forces a new resource to be created.
ReadonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicy: a read-only policy as documented below
Tags map[string]string: A mapping of tags to assign to the resource.

partnerServers FailoverGroupPartnerServer[]: A list of secondary servers as documented below
readWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicy: A read/write policy as documented below
resourceGroupName string: The name of the resource group containing the SQL server
serverName string: The name of the primary SQL server. Changing this forces a new resource to be created.
databases string[]: A list of database ids to add to the failover group
name string: The name of the failover group. Changing this forces a new resource to be created.
readonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicy: a read-only policy as documented below
tags {[key: string]: string}: A mapping of tags to assign to the resource.

partner_servers List[FailoverGroupPartnerServer]: A list of secondary servers as documented below
read_write_endpoint_failover_policy Dict[FailoverGroupReadWriteEndpointFailoverPolicy]: A read/write policy as documented below
resource_group_name str: The name of the resource group containing the SQL server
server_name str: The name of the primary SQL server. Changing this forces a new resource to be created.
databases List[str]: A list of database ids to add to the failover group
name str: The name of the failover group. Changing this forces a new resource to be created.
readonly_endpoint_failover_policy Dict[FailoverGroupReadonlyEndpointFailoverPolicy]: a read-only policy as documented below
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Location string: the location of the failover group.
Role string: local replication role of the failover group instance.

Id string: The provider-assigned unique ID for this managed resource.
Location string: the location of the failover group.
Role string: local replication role of the failover group instance.

id string: The provider-assigned unique ID for this managed resource.
location string: the location of the failover group.
role string: local replication role of the failover group instance.

id str: The provider-assigned unique ID for this managed resource.
location str: the location of the failover group.
role str: local replication role of the failover group instance.

Look up an Existing FailoverGroup Resource

Get an existing FailoverGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FailoverGroupState, opts?: CustomResourceOptions): FailoverGroup

static get(resource_name, id, opts=None, databases=None, location=None, name=None, partner_servers=None, read_write_endpoint_failover_policy=None, readonly_endpoint_failover_policy=None, resource_group_name=None, role=None, server_name=None, tags=None, __props__=None);

func GetFailoverGroup(ctx *Context, name string, id IDInput, state *FailoverGroupState, opts ...ResourceOption) (*FailoverGroup, error)

public static FailoverGroup Get(string name, Input<string> id, FailoverGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Databases List<string>: A list of database ids to add to the failover group
Location string: the location of the failover group.
Name string: The name of the failover group. Changing this forces a new resource to be created.
PartnerServers List<FailoverGroupPartnerServerArgs>: A list of secondary servers as documented below
ReadWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicyArgs: A read/write policy as documented below
ReadonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicyArgs: a read-only policy as documented below
ResourceGroupName string: The name of the resource group containing the SQL server
Role string: local replication role of the failover group instance.
ServerName string: The name of the primary SQL server. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

Databases []string: A list of database ids to add to the failover group
Location string: the location of the failover group.
Name string: The name of the failover group. Changing this forces a new resource to be created.
PartnerServers []FailoverGroupPartnerServer: A list of secondary servers as documented below
ReadWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicy: A read/write policy as documented below
ReadonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicy: a read-only policy as documented below
ResourceGroupName string: The name of the resource group containing the SQL server
Role string: local replication role of the failover group instance.
ServerName string: The name of the primary SQL server. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

databases string[]: A list of database ids to add to the failover group
location string: the location of the failover group.
name string: The name of the failover group. Changing this forces a new resource to be created.
partnerServers FailoverGroupPartnerServer[]: A list of secondary servers as documented below
readWriteEndpointFailoverPolicy FailoverGroupReadWriteEndpointFailoverPolicy: A read/write policy as documented below
readonlyEndpointFailoverPolicy FailoverGroupReadonlyEndpointFailoverPolicy: a read-only policy as documented below
resourceGroupName string: The name of the resource group containing the SQL server
role string: local replication role of the failover group instance.
serverName string: The name of the primary SQL server. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

databases List[str]: A list of database ids to add to the failover group
location str: the location of the failover group.
name str: The name of the failover group. Changing this forces a new resource to be created.
partner_servers List[FailoverGroupPartnerServer]: A list of secondary servers as documented below
read_write_endpoint_failover_policy Dict[FailoverGroupReadWriteEndpointFailoverPolicy]: A read/write policy as documented below
readonly_endpoint_failover_policy Dict[FailoverGroupReadonlyEndpointFailoverPolicy]: a read-only policy as documented below
resource_group_name str: The name of the resource group containing the SQL server
role str: local replication role of the failover group instance.
server_name str: The name of the primary SQL server. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

FailoverGroupPartnerServer

See the input and output API doc for this type.

Id string: the SQL server ID
Location string: the location of the failover group.
Role string: local replication role of the failover group instance.

Id string: the SQL server ID
Location string: the location of the failover group.
Role string: local replication role of the failover group instance.

id string: the SQL server ID
location string: the location of the failover group.
role string: local replication role of the failover group instance.

id str: the SQL server ID
location str: the location of the failover group.
role str: local replication role of the failover group instance.

FailoverGroupReadWriteEndpointFailoverPolicy

See the input and output API doc for this type.

Mode string: the failover mode. Possible values are Manual, Automatic
GraceMinutes int: Applies only if mode is Automatic. The grace period in minutes before failover with data loss is attempted

Mode string: the failover mode. Possible values are Manual, Automatic
GraceMinutes int: Applies only if mode is Automatic. The grace period in minutes before failover with data loss is attempted

mode string: the failover mode. Possible values are Manual, Automatic
graceMinutes number: Applies only if mode is Automatic. The grace period in minutes before failover with data loss is attempted

mode str: the failover mode. Possible values are Manual, Automatic
graceMinutes float: Applies only if mode is Automatic. The grace period in minutes before failover with data loss is attempted

FailoverGroupReadonlyEndpointFailoverPolicy

See the input and output API doc for this type.

Mode string: Failover policy for the read-only endpoint. Possible values are Enabled, and Disabled

Mode string: Failover policy for the read-only endpoint. Possible values are Enabled, and Disabled

mode string: Failover policy for the read-only endpoint. Possible values are Enabled, and Disabled

mode str: Failover policy for the read-only endpoint. Possible values are Enabled, and Disabled

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

FailoverGroup

Create a FailoverGroup Resource

FailoverGroup Resource Properties

Inputs

Outputs

Look up an Existing FailoverGroup Resource

Supporting Types

FailoverGroupPartnerServer

FailoverGroupReadWriteEndpointFailoverPolicy

FailoverGroupReadonlyEndpointFailoverPolicy

Package Details

On This Page