Class FailoverGroup

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

Inheritance

System.Object

Resource

CustomResource

FailoverGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Sql

Assembly: Pulumi.Azure.dll

Syntax

public class FailoverGroup : CustomResource

Constructors

FailoverGroup(String, FailoverGroupArgs, CustomResourceOptions)

Create a FailoverGroup resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FailoverGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Databases

A list of database ids to add to the failover group

Declaration

public Output<ImmutableArray<string>> Databases { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Location

the location of the failover group.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the failover group. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PartnerServers

A list of secondary servers as documented below

Declaration

public Output<ImmutableArray<FailoverGroupPartnerServer>> PartnerServers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<FailoverGroupPartnerServer>>

ReadonlyEndpointFailoverPolicy

a read-only policy as documented below

Declaration

public Output<FailoverGroupReadonlyEndpointFailoverPolicy> ReadonlyEndpointFailoverPolicy { get; }

Property Value

Type	Description
Output<FailoverGroupReadonlyEndpointFailoverPolicy>

ReadWriteEndpointFailoverPolicy

A read/write policy as documented below

Declaration

public Output<FailoverGroupReadWriteEndpointFailoverPolicy> ReadWriteEndpointFailoverPolicy { get; }

Property Value

Type	Description
Output<FailoverGroupReadWriteEndpointFailoverPolicy>

ResourceGroupName

The name of the resource group containing the SQL server

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Role

local replication role of the failover group instance.

Declaration

public Output<string> Role { get; }

Property Value

Type	Description
Output<System.String>

ServerName

The name of the primary SQL server. Changing this forces a new resource to be created.

Declaration

public Output<string> ServerName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, FailoverGroupState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FailoverGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FailoverGroup