We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Import
SQL Instance Failover Groups can be imported using the resource id, e.g.
$ pulumi import azure:sql/managedInstanceFailoverGroup:ManagedInstanceFailoverGroup example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Sql/locations/Location/instanceFailoverGroups/failoverGroup1
Create ManagedInstanceFailoverGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagedInstanceFailoverGroup(name: string, args: ManagedInstanceFailoverGroupArgs, opts?: CustomResourceOptions);@overload
def ManagedInstanceFailoverGroup(resource_name: str,
args: ManagedInstanceFailoverGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ManagedInstanceFailoverGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
managed_instance_name: Optional[str] = None,
partner_managed_instance_id: Optional[str] = None,
read_write_endpoint_failover_policy: Optional[ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
readonly_endpoint_failover_policy_enabled: Optional[bool] = None)func NewManagedInstanceFailoverGroup(ctx *Context, name string, args ManagedInstanceFailoverGroupArgs, opts ...ResourceOption) (*ManagedInstanceFailoverGroup, error)public ManagedInstanceFailoverGroup(string name, ManagedInstanceFailoverGroupArgs args, CustomResourceOptions? opts = null)
public ManagedInstanceFailoverGroup(String name, ManagedInstanceFailoverGroupArgs args)
public ManagedInstanceFailoverGroup(String name, ManagedInstanceFailoverGroupArgs args, CustomResourceOptions options)
type: azure:sql:ManagedInstanceFailoverGroup
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 ManagedInstanceFailoverGroupArgs
- 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 ManagedInstanceFailoverGroupArgs
- 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 ManagedInstanceFailoverGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagedInstanceFailoverGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ManagedInstanceFailoverGroupArgs
- 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 azureManagedInstanceFailoverGroupResource = new Azure.Sql.ManagedInstanceFailoverGroup("azureManagedInstanceFailoverGroupResource", new()
{
ManagedInstanceName = "string",
PartnerManagedInstanceId = "string",
ReadWriteEndpointFailoverPolicy = new Azure.Sql.Inputs.ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs
{
Mode = "string",
GraceMinutes = 0,
},
ResourceGroupName = "string",
Location = "string",
Name = "string",
ReadonlyEndpointFailoverPolicyEnabled = false,
});
example, err := sql.NewManagedInstanceFailoverGroup(ctx, "azureManagedInstanceFailoverGroupResource", &sql.ManagedInstanceFailoverGroupArgs{
ManagedInstanceName: pulumi.String("string"),
PartnerManagedInstanceId: pulumi.String("string"),
ReadWriteEndpointFailoverPolicy: &sql.ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs{
Mode: pulumi.String("string"),
GraceMinutes: pulumi.Int(0),
},
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
ReadonlyEndpointFailoverPolicyEnabled: pulumi.Bool(false),
})
var azureManagedInstanceFailoverGroupResource = new com.pulumi.azure.sql.ManagedInstanceFailoverGroup("azureManagedInstanceFailoverGroupResource", com.pulumi.azure.sql.ManagedInstanceFailoverGroupArgs.builder()
.managedInstanceName("string")
.partnerManagedInstanceId("string")
.readWriteEndpointFailoverPolicy(ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs.builder()
.mode("string")
.graceMinutes(0)
.build())
.resourceGroupName("string")
.location("string")
.name("string")
.readonlyEndpointFailoverPolicyEnabled(false)
.build());
azure_managed_instance_failover_group_resource = azure.sql.ManagedInstanceFailoverGroup("azureManagedInstanceFailoverGroupResource",
managed_instance_name="string",
partner_managed_instance_id="string",
read_write_endpoint_failover_policy={
"mode": "string",
"grace_minutes": 0,
},
resource_group_name="string",
location="string",
name="string",
readonly_endpoint_failover_policy_enabled=False)
const azureManagedInstanceFailoverGroupResource = new azure.sql.ManagedInstanceFailoverGroup("azureManagedInstanceFailoverGroupResource", {
managedInstanceName: "string",
partnerManagedInstanceId: "string",
readWriteEndpointFailoverPolicy: {
mode: "string",
graceMinutes: 0,
},
resourceGroupName: "string",
location: "string",
name: "string",
readonlyEndpointFailoverPolicyEnabled: false,
});
type: azure:sql:ManagedInstanceFailoverGroup
properties:
location: string
managedInstanceName: string
name: string
partnerManagedInstanceId: string
readWriteEndpointFailoverPolicy:
graceMinutes: 0
mode: string
readonlyEndpointFailoverPolicyEnabled: false
resourceGroupName: string
ManagedInstanceFailoverGroup 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 ManagedInstanceFailoverGroup resource accepts the following input properties:
- Managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - Resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- Location string
- The Azure Region where the SQL Instance Failover Group exists.
- Name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Readonly
Endpoint boolFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false.
- Managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy Args - A
read_write_endpoint_failover_policyblock as defined below. - Resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- Location string
- The Azure Region where the SQL Instance Failover Group exists.
- Name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Readonly
Endpoint boolFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false.
- managed
Instance StringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed StringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - resource
Group StringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- location String
- The Azure Region where the SQL Instance Failover Group exists.
- name String
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- readonly
Endpoint BooleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false.
- managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- location string
- The Azure Region where the SQL Instance Failover Group exists.
- name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- readonly
Endpoint booleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false.
- managed_
instance_ strname - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner_
managed_ strinstance_ id - ID of the SQL Managed Instance which will be replicated to.
- read_
write_ Managedendpoint_ failover_ policy Instance Failover Group Read Write Endpoint Failover Policy Args - A
read_write_endpoint_failover_policyblock as defined below. - resource_
group_ strname - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- location str
- The Azure Region where the SQL Instance Failover Group exists.
- name str
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- readonly_
endpoint_ boolfailover_ policy_ enabled - Failover policy for the read-only endpoint. Defaults to
false.
- managed
Instance StringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed StringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- read
Write Property MapEndpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - resource
Group StringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- location String
- The Azure Region where the SQL Instance Failover Group exists.
- name String
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- readonly
Endpoint BooleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false.
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagedInstanceFailoverGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Partner
Regions List<ManagedInstance Failover Group Partner Region> - A
partner_regionblock as defined below. - Role string
- The partner replication role of the SQL Instance Failover Group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Partner
Regions []ManagedInstance Failover Group Partner Region - A
partner_regionblock as defined below. - Role string
- The partner replication role of the SQL Instance Failover Group.
- id String
- The provider-assigned unique ID for this managed resource.
- partner
Regions List<ManagedInstance Failover Group Partner Region> - A
partner_regionblock as defined below. - role String
- The partner replication role of the SQL Instance Failover Group.
- id string
- The provider-assigned unique ID for this managed resource.
- partner
Regions ManagedInstance Failover Group Partner Region[] - A
partner_regionblock as defined below. - role string
- The partner replication role of the SQL Instance Failover Group.
- id str
- The provider-assigned unique ID for this managed resource.
- partner_
regions Sequence[ManagedInstance Failover Group Partner Region] - A
partner_regionblock as defined below. - role str
- The partner replication role of the SQL Instance Failover Group.
- id String
- The provider-assigned unique ID for this managed resource.
- partner
Regions List<Property Map> - A
partner_regionblock as defined below. - role String
- The partner replication role of the SQL Instance Failover Group.
Look up Existing ManagedInstanceFailoverGroup Resource
Get an existing ManagedInstanceFailoverGroup 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?: ManagedInstanceFailoverGroupState, opts?: CustomResourceOptions): ManagedInstanceFailoverGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
managed_instance_name: Optional[str] = None,
name: Optional[str] = None,
partner_managed_instance_id: Optional[str] = None,
partner_regions: Optional[Sequence[ManagedInstanceFailoverGroupPartnerRegionArgs]] = None,
read_write_endpoint_failover_policy: Optional[ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs] = None,
readonly_endpoint_failover_policy_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
role: Optional[str] = None) -> ManagedInstanceFailoverGroupfunc GetManagedInstanceFailoverGroup(ctx *Context, name string, id IDInput, state *ManagedInstanceFailoverGroupState, opts ...ResourceOption) (*ManagedInstanceFailoverGroup, error)public static ManagedInstanceFailoverGroup Get(string name, Input<string> id, ManagedInstanceFailoverGroupState? state, CustomResourceOptions? opts = null)public static ManagedInstanceFailoverGroup get(String name, Output<String> id, ManagedInstanceFailoverGroupState state, CustomResourceOptions options)resources: _: type: azure:sql:ManagedInstanceFailoverGroup get: id: ${id}- 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.
- 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.
- Location string
- The Azure Region where the SQL Instance Failover Group exists.
- Managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- Partner
Regions List<ManagedInstance Failover Group Partner Region> - A
partner_regionblock as defined below. - Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - Readonly
Endpoint boolFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false. - Resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- Role string
- The partner replication role of the SQL Instance Failover Group.
- Location string
- The Azure Region where the SQL Instance Failover Group exists.
- Managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- Partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- Partner
Regions []ManagedInstance Failover Group Partner Region Args - A
partner_regionblock as defined below. - Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy Args - A
read_write_endpoint_failover_policyblock as defined below. - Readonly
Endpoint boolFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false. - Resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- Role string
- The partner replication role of the SQL Instance Failover Group.
- location String
- The Azure Region where the SQL Instance Failover Group exists.
- managed
Instance StringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- name String
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed StringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- partner
Regions List<ManagedInstance Failover Group Partner Region> - A
partner_regionblock as defined below. - read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - readonly
Endpoint BooleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false. - resource
Group StringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- role String
- The partner replication role of the SQL Instance Failover Group.
- location string
- The Azure Region where the SQL Instance Failover Group exists.
- managed
Instance stringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- name string
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed stringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- partner
Regions ManagedInstance Failover Group Partner Region[] - A
partner_regionblock as defined below. - read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - readonly
Endpoint booleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false. - resource
Group stringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- role string
- The partner replication role of the SQL Instance Failover Group.
- location str
- The Azure Region where the SQL Instance Failover Group exists.
- managed_
instance_ strname - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- name str
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner_
managed_ strinstance_ id - ID of the SQL Managed Instance which will be replicated to.
- partner_
regions Sequence[ManagedInstance Failover Group Partner Region Args] - A
partner_regionblock as defined below. - read_
write_ Managedendpoint_ failover_ policy Instance Failover Group Read Write Endpoint Failover Policy Args - A
read_write_endpoint_failover_policyblock as defined below. - readonly_
endpoint_ boolfailover_ policy_ enabled - Failover policy for the read-only endpoint. Defaults to
false. - resource_
group_ strname - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- role str
- The partner replication role of the SQL Instance Failover Group.
- location String
- The Azure Region where the SQL Instance Failover Group exists.
- managed
Instance StringName - The name of the SQL Managed Instance which will be replicated using a SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- name String
- The name which should be used for this SQL Instance Failover Group. Changing this forces a new SQL Instance Failover Group to be created.
- partner
Managed StringInstance Id - ID of the SQL Managed Instance which will be replicated to.
- partner
Regions List<Property Map> - A
partner_regionblock as defined below. - read
Write Property MapEndpoint Failover Policy - A
read_write_endpoint_failover_policyblock as defined below. - readonly
Endpoint BooleanFailover Policy Enabled - Failover policy for the read-only endpoint. Defaults to
false. - resource
Group StringName - The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created.
- role String
- The partner replication role of the SQL Instance Failover Group.
Supporting Types
ManagedInstanceFailoverGroupPartnerRegion, ManagedInstanceFailoverGroupPartnerRegionArgs
ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy, ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs
- Mode string
- The failover mode. Possible values are
Manual,Automatic - Grace
Minutes int - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
- Mode string
- The failover mode. Possible values are
Manual,Automatic - Grace
Minutes int - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
- mode String
- The failover mode. Possible values are
Manual,Automatic - grace
Minutes Integer - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
- mode string
- The failover mode. Possible values are
Manual,Automatic - grace
Minutes number - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
- mode str
- The failover mode. Possible values are
Manual,Automatic - grace_
minutes int - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
- mode String
- The failover mode. Possible values are
Manual,Automatic - grace
Minutes Number - Applies only if
modeisAutomatic. The grace period in minutes before failover with data loss is attempted.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
