Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getInstanceFailoverGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getInstanceFailoverGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a failover group.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2017-10-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getInstanceFailoverGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstanceFailoverGroup(args: GetInstanceFailoverGroupArgs, opts?: InvokeOptions): Promise<GetInstanceFailoverGroupResult>
function getInstanceFailoverGroupOutput(args: GetInstanceFailoverGroupOutputArgs, opts?: InvokeOptions): Output<GetInstanceFailoverGroupResult>
Copy
def get_instance_failover_group(failover_group_name: Optional[str] = None,
                                location_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetInstanceFailoverGroupResult
def get_instance_failover_group_output(failover_group_name: Optional[pulumi.Input[str]] = None,
                                location_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetInstanceFailoverGroupResult]
Copy
func LookupInstanceFailoverGroup(ctx *Context, args *LookupInstanceFailoverGroupArgs, opts ...InvokeOption) (*LookupInstanceFailoverGroupResult, error)
func LookupInstanceFailoverGroupOutput(ctx *Context, args *LookupInstanceFailoverGroupOutputArgs, opts ...InvokeOption) LookupInstanceFailoverGroupResultOutput
Copy

> Note: This function is named LookupInstanceFailoverGroup in the Go SDK.

public static class GetInstanceFailoverGroup 
{
    public static Task<GetInstanceFailoverGroupResult> InvokeAsync(GetInstanceFailoverGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceFailoverGroupResult> Invoke(GetInstanceFailoverGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInstanceFailoverGroupResult> getInstanceFailoverGroup(GetInstanceFailoverGroupArgs args, InvokeOptions options)
public static Output<GetInstanceFailoverGroupResult> getInstanceFailoverGroup(GetInstanceFailoverGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getInstanceFailoverGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FailoverGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the failover group.
LocationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the region where the resource is located.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
FailoverGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the failover group.
LocationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the region where the resource is located.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the failover group.
locationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the region where the resource is located.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the failover group.
locationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the region where the resource is located.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
failover_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the failover group.
location_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the region where the resource is located.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the failover group.
locationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the region where the resource is located.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

getInstanceFailoverGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
ManagedInstancePairs List<Pulumi.AzureNative.Sql.Outputs.ManagedInstancePairInfoResponse>
List of managed instance pairs in the failover group.
Name string
Resource name.
PartnerRegions List<Pulumi.AzureNative.Sql.Outputs.PartnerRegionInfoResponse>
Partner region information for the failover group.
ReadWriteEndpoint Pulumi.AzureNative.Sql.Outputs.InstanceFailoverGroupReadWriteEndpointResponse
Read-write endpoint of the failover group instance.
ReplicationRole string
Local replication role of the failover group instance.
ReplicationState string
Replication state of the failover group instance.
Type string
Resource type.
ReadOnlyEndpoint Pulumi.AzureNative.Sql.Outputs.InstanceFailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
SecondaryType string
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
ManagedInstancePairs []ManagedInstancePairInfoResponse
List of managed instance pairs in the failover group.
Name string
Resource name.
PartnerRegions []PartnerRegionInfoResponse
Partner region information for the failover group.
ReadWriteEndpoint InstanceFailoverGroupReadWriteEndpointResponse
Read-write endpoint of the failover group instance.
ReplicationRole string
Local replication role of the failover group instance.
ReplicationState string
Replication state of the failover group instance.
Type string
Resource type.
ReadOnlyEndpoint InstanceFailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
SecondaryType string
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
managedInstancePairs List<ManagedInstancePairInfoResponse>
List of managed instance pairs in the failover group.
name String
Resource name.
partnerRegions List<PartnerRegionInfoResponse>
Partner region information for the failover group.
readWriteEndpoint InstanceFailoverGroupReadWriteEndpointResponse
Read-write endpoint of the failover group instance.
replicationRole String
Local replication role of the failover group instance.
replicationState String
Replication state of the failover group instance.
type String
Resource type.
readOnlyEndpoint InstanceFailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
secondaryType String
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
azureApiVersion string
The Azure API version of the resource.
id string
Resource ID.
managedInstancePairs ManagedInstancePairInfoResponse[]
List of managed instance pairs in the failover group.
name string
Resource name.
partnerRegions PartnerRegionInfoResponse[]
Partner region information for the failover group.
readWriteEndpoint InstanceFailoverGroupReadWriteEndpointResponse
Read-write endpoint of the failover group instance.
replicationRole string
Local replication role of the failover group instance.
replicationState string
Replication state of the failover group instance.
type string
Resource type.
readOnlyEndpoint InstanceFailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
secondaryType string
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
azure_api_version str
The Azure API version of the resource.
id str
Resource ID.
managed_instance_pairs Sequence[ManagedInstancePairInfoResponse]
List of managed instance pairs in the failover group.
name str
Resource name.
partner_regions Sequence[PartnerRegionInfoResponse]
Partner region information for the failover group.
read_write_endpoint InstanceFailoverGroupReadWriteEndpointResponse
Read-write endpoint of the failover group instance.
replication_role str
Local replication role of the failover group instance.
replication_state str
Replication state of the failover group instance.
type str
Resource type.
read_only_endpoint InstanceFailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
secondary_type str
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
managedInstancePairs List<Property Map>
List of managed instance pairs in the failover group.
name String
Resource name.
partnerRegions List<Property Map>
Partner region information for the failover group.
readWriteEndpoint Property Map
Read-write endpoint of the failover group instance.
replicationRole String
Local replication role of the failover group instance.
replicationState String
Replication state of the failover group instance.
type String
Resource type.
readOnlyEndpoint Property Map
Read-only endpoint of the failover group instance.
secondaryType String
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.

Supporting Types

InstanceFailoverGroupReadOnlyEndpointResponse

FailoverPolicy string
Failover policy of the read-only endpoint for the failover group.
FailoverPolicy string
Failover policy of the read-only endpoint for the failover group.
failoverPolicy String
Failover policy of the read-only endpoint for the failover group.
failoverPolicy string
Failover policy of the read-only endpoint for the failover group.
failover_policy str
Failover policy of the read-only endpoint for the failover group.
failoverPolicy String
Failover policy of the read-only endpoint for the failover group.

InstanceFailoverGroupReadWriteEndpointResponse

FailoverPolicy This property is required. string
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
FailoverWithDataLossGracePeriodMinutes int
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
FailoverPolicy This property is required. string
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
FailoverWithDataLossGracePeriodMinutes int
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverPolicy This property is required. String
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverWithDataLossGracePeriodMinutes Integer
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverPolicy This property is required. string
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverWithDataLossGracePeriodMinutes number
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failover_policy This property is required. str
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failover_with_data_loss_grace_period_minutes int
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverPolicy This property is required. String
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
failoverWithDataLossGracePeriodMinutes Number
Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

ManagedInstancePairInfoResponse

PartnerManagedInstanceId string
Id of Partner Managed Instance in pair.
PrimaryManagedInstanceId string
Id of Primary Managed Instance in pair.
PartnerManagedInstanceId string
Id of Partner Managed Instance in pair.
PrimaryManagedInstanceId string
Id of Primary Managed Instance in pair.
partnerManagedInstanceId String
Id of Partner Managed Instance in pair.
primaryManagedInstanceId String
Id of Primary Managed Instance in pair.
partnerManagedInstanceId string
Id of Partner Managed Instance in pair.
primaryManagedInstanceId string
Id of Primary Managed Instance in pair.
partner_managed_instance_id str
Id of Partner Managed Instance in pair.
primary_managed_instance_id str
Id of Primary Managed Instance in pair.
partnerManagedInstanceId String
Id of Partner Managed Instance in pair.
primaryManagedInstanceId String
Id of Primary Managed Instance in pair.

PartnerRegionInfoResponse

ReplicationRole This property is required. string
Replication role of the partner managed instances.
Location string
Geo location of the partner managed instances.
ReplicationRole This property is required. string
Replication role of the partner managed instances.
Location string
Geo location of the partner managed instances.
replicationRole This property is required. String
Replication role of the partner managed instances.
location String
Geo location of the partner managed instances.
replicationRole This property is required. string
Replication role of the partner managed instances.
location string
Geo location of the partner managed instances.
replication_role This property is required. str
Replication role of the partner managed instances.
location str
Geo location of the partner managed instances.
replicationRole This property is required. String
Replication role of the partner managed instances.
location String
Geo location of the partner managed instances.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native