We recommend using Azure Native.
azure.mssql.ManagedInstanceFailoverGroup
Explore with Pulumi AI
Import
SQL Instance Failover Groups can be imported using the resource id
, e.g.
$ pulumi import azure:mssql/managedInstanceFailoverGroup:ManagedInstanceFailoverGroup example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Sql/locations/Location/instanceFailoverGroups/failoverGroup1
Create ManagedInstanceFailoverGroup Resource
new ManagedInstanceFailoverGroup(name: string, args: ManagedInstanceFailoverGroupArgs, opts?: CustomResourceOptions);
@overload
def ManagedInstanceFailoverGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
managed_instance_id: Optional[str] = None,
name: Optional[str] = None,
partner_managed_instance_id: Optional[str] = None,
read_write_endpoint_failover_policy: Optional[ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs] = None,
readonly_endpoint_failover_policy_enabled: Optional[bool] = None)
@overload
def ManagedInstanceFailoverGroup(resource_name: str,
args: ManagedInstanceFailoverGroupArgs,
opts: Optional[ResourceOptions] = 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:mssql:ManagedInstanceFailoverGroup
properties: # The arguments to resource properties.
options: # 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.
- 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.
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
The ManagedInstanceFailoverGroup resource accepts the following input properties:
- Managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- Partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- Location string
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- Name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- Readonly
Endpoint boolFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.
- Managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- Partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy Args A
read_write_endpoint_failover_policy
block as defined below.- Location string
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- Name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- Readonly
Endpoint boolFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.
- managed
Instance StringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed StringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- location String
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- name String
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- readonly
Endpoint BooleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.
- managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- location string
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- readonly
Endpoint booleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.
- managed_
instance_ strid The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner_
managed_ strinstance_ id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- read_
write_ Managedendpoint_ failover_ policy Instance Failover Group Read Write Endpoint Failover Policy Args A
read_write_endpoint_failover_policy
block as defined below.- location str
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- name str
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- readonly_
endpoint_ boolfailover_ policy_ enabled Failover policy for the read-only endpoint. Defaults to
true
.
- managed
Instance StringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed StringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- read
Write Property MapEndpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- location String
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- name String
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- readonly
Endpoint BooleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.
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_region
block as defined below.- Role string
The partner replication role of the Managed Instance Failover Group.
- Id string
The provider-assigned unique ID for this managed resource.
- Partner
Regions []ManagedInstance Failover Group Partner Region A
partner_region
block as defined below.- Role string
The partner replication role of the Managed Instance Failover Group.
- id String
The provider-assigned unique ID for this managed resource.
- partner
Regions List<ManagedInstance Failover Group Partner Region> A
partner_region
block as defined below.- role String
The partner replication role of the Managed Instance Failover Group.
- id string
The provider-assigned unique ID for this managed resource.
- partner
Regions ManagedInstance Failover Group Partner Region[] A
partner_region
block as defined below.- role string
The partner replication role of the Managed Instance Failover Group.
- id str
The provider-assigned unique ID for this managed resource.
- partner_
regions Sequence[ManagedInstance Failover Group Partner Region] A
partner_region
block as defined below.- role str
The partner replication role of the Managed Instance Failover Group.
- id String
The provider-assigned unique ID for this managed resource.
- partner
Regions List<Property Map> A
partner_region
block as defined below.- role String
The partner replication role of the Managed 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_id: 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,
role: Optional[str] = None) -> ManagedInstanceFailoverGroup
func 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)
Resource lookup is not supported in YAML
- 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 Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- Managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- Name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- Partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- Partner
Regions List<ManagedInstance Failover Group Partner Region> A
partner_region
block as defined below.- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- Readonly
Endpoint boolFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.- Role string
The partner replication role of the Managed Instance Failover Group.
- Location string
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- Managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- Name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- Partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- Partner
Regions []ManagedInstance Failover Group Partner Region Args A
partner_region
block as defined below.- Read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy Args A
read_write_endpoint_failover_policy
block as defined below.- Readonly
Endpoint boolFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.- Role string
The partner replication role of the Managed Instance Failover Group.
- location String
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- managed
Instance StringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- name String
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed StringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- partner
Regions List<ManagedInstance Failover Group Partner Region> A
partner_region
block as defined below.- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- readonly
Endpoint BooleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.- role String
The partner replication role of the Managed Instance Failover Group.
- location string
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- managed
Instance stringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- name string
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed stringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- partner
Regions ManagedInstance Failover Group Partner Region[] A
partner_region
block as defined below.- read
Write ManagedEndpoint Failover Policy Instance Failover Group Read Write Endpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- readonly
Endpoint booleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.- role string
The partner replication role of the Managed Instance Failover Group.
- location str
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- managed_
instance_ strid The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- name str
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner_
managed_ strinstance_ id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- partner_
regions Sequence[ManagedInstance Failover Group Partner Region Args] A
partner_region
block as defined below.- read_
write_ Managedendpoint_ failover_ policy Instance Failover Group Read Write Endpoint Failover Policy Args A
read_write_endpoint_failover_policy
block as defined below.- readonly_
endpoint_ boolfailover_ policy_ enabled Failover policy for the read-only endpoint. Defaults to
true
.- role str
The partner replication role of the Managed Instance Failover Group.
- location String
The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.
- managed
Instance StringId The ID of the Azure SQL Managed Instance which will be replicated using a Managed Instance Failover Group. Changing this forces a new resource to be created.
- name String
The name which should be used for this Managed Instance Failover Group. Changing this forces a new resource to be created.
- partner
Managed StringInstance Id The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.
- partner
Regions List<Property Map> A
partner_region
block as defined below.- read
Write Property MapEndpoint Failover Policy A
read_write_endpoint_failover_policy
block as defined below.- readonly
Endpoint BooleanFailover Policy Enabled Failover policy for the read-only endpoint. Defaults to
true
.- role String
The partner replication role of the Managed Instance Failover Group.
Supporting Types
ManagedInstanceFailoverGroupPartnerRegion, ManagedInstanceFailoverGroupPartnerRegionArgs
ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy, ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs
- Mode string
The failover mode. Possible values are
Automatic
orManual
.- Grace
Minutes int Applies only if
mode
isAutomatic
. The grace period in minutes before failover with data loss is attempted.
- Mode string
The failover mode. Possible values are
Automatic
orManual
.- Grace
Minutes int Applies only if
mode
isAutomatic
. The grace period in minutes before failover with data loss is attempted.
- mode String
The failover mode. Possible values are
Automatic
orManual
.- grace
Minutes Integer Applies only if
mode
isAutomatic
. The grace period in minutes before failover with data loss is attempted.
- mode string
The failover mode. Possible values are
Automatic
orManual
.- grace
Minutes number Applies only if
mode
isAutomatic
. The grace period in minutes before failover with data loss is attempted.
- mode str
The failover mode. Possible values are
Automatic
orManual
.- grace_
minutes int Applies only if
mode
isAutomatic
. The grace period in minutes before failover with data loss is attempted.
- mode String
The failover mode. Possible values are
Automatic
orManual
.- grace
Minutes Number Applies only if
mode
isAutomatic
. 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
azurerm
Terraform Provider.