Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getFailoverGroup
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getFailoverGroup

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a failover group.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2015-05-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 getFailoverGroup

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 getFailoverGroup(args: GetFailoverGroupArgs, opts?: InvokeOptions): Promise<GetFailoverGroupResult>
function getFailoverGroupOutput(args: GetFailoverGroupOutputArgs, opts?: InvokeOptions): Output<GetFailoverGroupResult>
Copy
def get_failover_group(failover_group_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFailoverGroupResult
def get_failover_group_output(failover_group_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       server_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFailoverGroupResult]
Copy
func LookupFailoverGroup(ctx *Context, args *LookupFailoverGroupArgs, opts ...InvokeOption) (*LookupFailoverGroupResult, error)
func LookupFailoverGroupOutput(ctx *Context, args *LookupFailoverGroupOutputArgs, opts ...InvokeOption) LookupFailoverGroupResultOutput
Copy

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

public static class GetFailoverGroup 
{
    public static Task<GetFailoverGroupResult> InvokeAsync(GetFailoverGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetFailoverGroupResult> Invoke(GetFailoverGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFailoverGroupResult> getFailoverGroup(GetFailoverGroupArgs args, InvokeOptions options)
public static Output<GetFailoverGroupResult> getFailoverGroup(GetFailoverGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getFailoverGroup
  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.
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.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server containing the failover group.
FailoverGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the failover group.
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.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server containing the failover group.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the failover group.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server containing the failover group.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the failover group.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server containing the failover group.
failover_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the failover group.
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.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server containing the failover group.
failoverGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the failover group.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server containing the failover group.

getFailoverGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
PartnerServers List<Pulumi.AzureNative.Sql.Outputs.PartnerInfoResponse>
List of partner server information for the failover group.
ReadWriteEndpoint Pulumi.AzureNative.Sql.Outputs.FailoverGroupReadWriteEndpointResponse
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.
Databases List<string>
List of databases in the failover group.
ReadOnlyEndpoint Pulumi.AzureNative.Sql.Outputs.FailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
PartnerServers []PartnerInfoResponse
List of partner server information for the failover group.
ReadWriteEndpoint FailoverGroupReadWriteEndpointResponse
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.
Databases []string
List of databases in the failover group.
ReadOnlyEndpoint FailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
partnerServers List<PartnerInfoResponse>
List of partner server information for the failover group.
readWriteEndpoint FailoverGroupReadWriteEndpointResponse
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.
databases List<String>
List of databases in the failover group.
readOnlyEndpoint FailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
partnerServers PartnerInfoResponse[]
List of partner server information for the failover group.
readWriteEndpoint FailoverGroupReadWriteEndpointResponse
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.
databases string[]
List of databases in the failover group.
readOnlyEndpoint FailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
partner_servers Sequence[PartnerInfoResponse]
List of partner server information for the failover group.
read_write_endpoint FailoverGroupReadWriteEndpointResponse
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.
databases Sequence[str]
List of databases in the failover group.
read_only_endpoint FailoverGroupReadOnlyEndpointResponse
Read-only endpoint of the failover group instance.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
partnerServers List<Property Map>
List of partner server 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.
databases List<String>
List of databases in the failover group.
readOnlyEndpoint Property Map
Read-only endpoint of the failover group instance.
tags Map<String>
Resource tags.

Supporting Types

FailoverGroupReadOnlyEndpointResponse

FailoverPolicy string
Failover policy of the read-only endpoint for the failover group.
TargetServer string
The target partner server where the read-only endpoint points to.
FailoverPolicy string
Failover policy of the read-only endpoint for the failover group.
TargetServer string
The target partner server where the read-only endpoint points to.
failoverPolicy String
Failover policy of the read-only endpoint for the failover group.
targetServer String
The target partner server where the read-only endpoint points to.
failoverPolicy string
Failover policy of the read-only endpoint for the failover group.
targetServer string
The target partner server where the read-only endpoint points to.
failover_policy str
Failover policy of the read-only endpoint for the failover group.
target_server str
The target partner server where the read-only endpoint points to.
failoverPolicy String
Failover policy of the read-only endpoint for the failover group.
targetServer String
The target partner server where the read-only endpoint points to.

FailoverGroupReadWriteEndpointResponse

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.

PartnerInfoResponse

Id This property is required. string
Resource identifier of the partner server.
Location This property is required. string
Geo location of the partner server.
ReplicationRole This property is required. string
Replication role of the partner server.
Id This property is required. string
Resource identifier of the partner server.
Location This property is required. string
Geo location of the partner server.
ReplicationRole This property is required. string
Replication role of the partner server.
id This property is required. String
Resource identifier of the partner server.
location This property is required. String
Geo location of the partner server.
replicationRole This property is required. String
Replication role of the partner server.
id This property is required. string
Resource identifier of the partner server.
location This property is required. string
Geo location of the partner server.
replicationRole This property is required. string
Replication role of the partner server.
id This property is required. str
Resource identifier of the partner server.
location This property is required. str
Geo location of the partner server.
replication_role This property is required. str
Replication role of the partner server.
id This property is required. String
Resource identifier of the partner server.
location This property is required. String
Geo location of the partner server.
replicationRole This property is required. String
Replication role of the partner server.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native