Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. mssql
  5. ManagedInstanceFailoverGroup

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

azure.mssql.ManagedInstanceFailoverGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
pulumi/pulumi-azure

    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:

    ManagedInstanceId string

    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.

    PartnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    ReadWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    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.

    ReadonlyEndpointFailoverPolicyEnabled bool

    Failover policy for the read-only endpoint. Defaults to true.

    ManagedInstanceId string

    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.

    PartnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    ReadWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs

    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.

    ReadonlyEndpointFailoverPolicyEnabled bool

    Failover policy for the read-only endpoint. Defaults to true.

    managedInstanceId String

    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.

    partnerManagedInstanceId String

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    readWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    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.

    readonlyEndpointFailoverPolicyEnabled Boolean

    Failover policy for the read-only endpoint. Defaults to true.

    managedInstanceId string

    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.

    partnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    readWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    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.

    readonlyEndpointFailoverPolicyEnabled boolean

    Failover policy for the read-only endpoint. Defaults to true.

    managed_instance_id str

    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_instance_id str

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    read_write_endpoint_failover_policy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs

    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_failover_policy_enabled bool

    Failover policy for the read-only endpoint. Defaults to true.

    managedInstanceId String

    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.

    partnerManagedInstanceId String

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    readWriteEndpointFailoverPolicy Property Map

    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.

    readonlyEndpointFailoverPolicyEnabled Boolean

    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.

    PartnerRegions List<ManagedInstanceFailoverGroupPartnerRegion>

    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.

    PartnerRegions []ManagedInstanceFailoverGroupPartnerRegion

    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.

    partnerRegions List<ManagedInstanceFailoverGroupPartnerRegion>

    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.

    partnerRegions ManagedInstanceFailoverGroupPartnerRegion[]

    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[ManagedInstanceFailoverGroupPartnerRegion]

    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.

    partnerRegions 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.
    The following state arguments are supported:
    Location string

    The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.

    ManagedInstanceId string

    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.

    PartnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    PartnerRegions List<ManagedInstanceFailoverGroupPartnerRegion>

    A partner_region block as defined below.

    ReadWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    A read_write_endpoint_failover_policy block as defined below.

    ReadonlyEndpointFailoverPolicyEnabled bool

    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.

    ManagedInstanceId string

    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.

    PartnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    PartnerRegions []ManagedInstanceFailoverGroupPartnerRegionArgs

    A partner_region block as defined below.

    ReadWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs

    A read_write_endpoint_failover_policy block as defined below.

    ReadonlyEndpointFailoverPolicyEnabled bool

    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.

    managedInstanceId String

    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.

    partnerManagedInstanceId String

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    partnerRegions List<ManagedInstanceFailoverGroupPartnerRegion>

    A partner_region block as defined below.

    readWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    A read_write_endpoint_failover_policy block as defined below.

    readonlyEndpointFailoverPolicyEnabled Boolean

    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.

    managedInstanceId string

    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.

    partnerManagedInstanceId string

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    partnerRegions ManagedInstanceFailoverGroupPartnerRegion[]

    A partner_region block as defined below.

    readWriteEndpointFailoverPolicy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy

    A read_write_endpoint_failover_policy block as defined below.

    readonlyEndpointFailoverPolicyEnabled boolean

    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_id str

    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_instance_id str

    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[ManagedInstanceFailoverGroupPartnerRegionArgs]

    A partner_region block as defined below.

    read_write_endpoint_failover_policy ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs

    A read_write_endpoint_failover_policy block as defined below.

    readonly_endpoint_failover_policy_enabled bool

    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.

    managedInstanceId String

    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.

    partnerManagedInstanceId String

    The ID of the Azure SQL Managed Instance which will be replicated to. Changing this forces a new resource to be created.

    partnerRegions List<Property Map>

    A partner_region block as defined below.

    readWriteEndpointFailoverPolicy Property Map

    A read_write_endpoint_failover_policy block as defined below.

    readonlyEndpointFailoverPolicyEnabled Boolean

    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

    Location string

    The Azure Region where the Managed Instance Failover Group should exist. Changing this forces a new resource to be created.

    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.

    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.

    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.

    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.

    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.

    role String

    The partner replication role of the Managed Instance Failover Group.

    ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicy, ManagedInstanceFailoverGroupReadWriteEndpointFailoverPolicyArgs

    Mode string

    The failover mode. Possible values are Automatic or Manual.

    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 Automatic or Manual.

    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 Automatic or Manual.

    graceMinutes Integer

    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 Automatic or Manual.

    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 Automatic or Manual.

    grace_minutes 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 Automatic or Manual.

    graceMinutes Number

    Applies only if mode is Automatic. 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.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi
    pulumi/pulumi-azure