Azure Native v2.8.0, Sep 18 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.8.0 published on Monday, Sep 18, 2023 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 v1 docs if using the v1 version of this package.

Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

pulumi/pulumi-azure-native

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>

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]

func LookupInstanceFailoverGroup(ctx *Context, args *LookupInstanceFailoverGroupArgs, opts ...InvokeOption) (*LookupInstanceFailoverGroupResult, error)
func LookupInstanceFailoverGroupOutput(ctx *Context, args *LookupInstanceFailoverGroupOutputArgs, opts ...InvokeOption) LookupInstanceFailoverGroupResultOutput

> 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)
}

public static CompletableFuture<GetInstanceFailoverGroupResult> getInstanceFailoverGroup(GetInstanceFailoverGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:sql:getInstanceFailoverGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

FailoverGroupName string: The name of the failover group.
LocationName string: The name of the region where the resource is located.
ResourceGroupName 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 string: The name of the failover group.
LocationName string: The name of the region where the resource is located.
ResourceGroupName 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 String: The name of the failover group.
locationName String: The name of the region where the resource is located.
resourceGroupName 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 string: The name of the failover group.
locationName string: The name of the region where the resource is located.
resourceGroupName 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 str: The name of the failover group.
location_name str: The name of the region where the resource is located.
resource_group_name 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 String: The name of the failover group.
locationName String: The name of the region where the resource is located.
resourceGroupName 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:

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.

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.

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.

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.

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.

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.

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 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 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 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 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 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 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 string: Replication role of the partner managed instances.
Location string: Geo location of the partner managed instances.

ReplicationRole string: Replication role of the partner managed instances.
Location string: Geo location of the partner managed instances.

replicationRole String: Replication role of the partner managed instances.
location String: Geo location of the partner managed instances.

replicationRole string: Replication role of the partner managed instances.
location string: Geo location of the partner managed instances.

replication_role str: Replication role of the partner managed instances.
location str: Geo location of the partner managed instances.

replicationRole 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 v1 docs if using the v1 version of this package.

Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.sql.getInstanceFailoverGroup

On this page

On this page

Using getInstanceFailoverGroup

getInstanceFailoverGroup Result

Supporting Types

InstanceFailoverGroupReadOnlyEndpointResponse

InstanceFailoverGroupReadWriteEndpointResponse

ManagedInstancePairInfoResponse

PartnerRegionInfoResponse

Package Details

On this page

On this page