Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurearcdata
  5. getFailoverGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azurearcdata.getFailoverGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves a failover group resource Azure REST API version: 2023-01-15-preview.

Other available API versions: 2024-01-01, 2024-05-01-preview.

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,
                       sql_managed_instance_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,
                       sql_managed_instance_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:azurearcdata: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 Azure resource group
SqlManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Managed Instance
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 Azure resource group
SqlManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Managed Instance
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 Azure resource group
sqlManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Managed Instance
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 Azure resource group
sqlManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Managed Instance
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 Azure resource group
sql_managed_instance_name
This property is required.
Changes to this property will trigger replacement.
str
Name of SQL Managed Instance
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 Azure resource group
sqlManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Managed Instance

getFailoverGroup Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.AzureArcData.Outputs.FailoverGroupPropertiesResponse
null
SystemData Pulumi.AzureNative.AzureArcData.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties FailoverGroupPropertiesResponse
null
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties FailoverGroupPropertiesResponse
null
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties FailoverGroupPropertiesResponse
null
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties FailoverGroupPropertiesResponse
null
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
null
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

FailoverGroupPropertiesResponse

PartnerManagedInstanceId This property is required. string
The resource ID of the partner SQL managed instance.
ProvisioningState This property is required. string
The provisioning state of the failover group resource.
Spec This property is required. Pulumi.AzureNative.AzureArcData.Inputs.FailoverGroupSpecResponse
The specifications of the failover group resource.
Status object
The status of the failover group custom resource.
PartnerManagedInstanceId This property is required. string
The resource ID of the partner SQL managed instance.
ProvisioningState This property is required. string
The provisioning state of the failover group resource.
Spec This property is required. FailoverGroupSpecResponse
The specifications of the failover group resource.
Status interface{}
The status of the failover group custom resource.
partnerManagedInstanceId This property is required. String
The resource ID of the partner SQL managed instance.
provisioningState This property is required. String
The provisioning state of the failover group resource.
spec This property is required. FailoverGroupSpecResponse
The specifications of the failover group resource.
status Object
The status of the failover group custom resource.
partnerManagedInstanceId This property is required. string
The resource ID of the partner SQL managed instance.
provisioningState This property is required. string
The provisioning state of the failover group resource.
spec This property is required. FailoverGroupSpecResponse
The specifications of the failover group resource.
status any
The status of the failover group custom resource.
partner_managed_instance_id This property is required. str
The resource ID of the partner SQL managed instance.
provisioning_state This property is required. str
The provisioning state of the failover group resource.
spec This property is required. FailoverGroupSpecResponse
The specifications of the failover group resource.
status Any
The status of the failover group custom resource.
partnerManagedInstanceId This property is required. String
The resource ID of the partner SQL managed instance.
provisioningState This property is required. String
The provisioning state of the failover group resource.
spec This property is required. Property Map
The specifications of the failover group resource.
status Any
The status of the failover group custom resource.

FailoverGroupSpecResponse

Role This property is required. string
The role of the SQL managed instance in this failover group.
PartnerMI string
The name of the partner SQL managed instance.
PartnerMirroringCert string
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
PartnerMirroringURL string
The mirroring endpoint URL of the partner SQL managed instance.
PartnerSyncMode string
The partner sync mode of the SQL managed instance.
SharedName string
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
SourceMI string
The name of the SQL managed instance with this failover group role.
Role This property is required. string
The role of the SQL managed instance in this failover group.
PartnerMI string
The name of the partner SQL managed instance.
PartnerMirroringCert string
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
PartnerMirroringURL string
The mirroring endpoint URL of the partner SQL managed instance.
PartnerSyncMode string
The partner sync mode of the SQL managed instance.
SharedName string
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
SourceMI string
The name of the SQL managed instance with this failover group role.
role This property is required. String
The role of the SQL managed instance in this failover group.
partnerMI String
The name of the partner SQL managed instance.
partnerMirroringCert String
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
partnerMirroringURL String
The mirroring endpoint URL of the partner SQL managed instance.
partnerSyncMode String
The partner sync mode of the SQL managed instance.
sharedName String
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
sourceMI String
The name of the SQL managed instance with this failover group role.
role This property is required. string
The role of the SQL managed instance in this failover group.
partnerMI string
The name of the partner SQL managed instance.
partnerMirroringCert string
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
partnerMirroringURL string
The mirroring endpoint URL of the partner SQL managed instance.
partnerSyncMode string
The partner sync mode of the SQL managed instance.
sharedName string
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
sourceMI string
The name of the SQL managed instance with this failover group role.
role This property is required. str
The role of the SQL managed instance in this failover group.
partner_mi str
The name of the partner SQL managed instance.
partner_mirroring_cert str
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
partner_mirroring_url str
The mirroring endpoint URL of the partner SQL managed instance.
partner_sync_mode str
The partner sync mode of the SQL managed instance.
shared_name str
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
source_mi str
The name of the SQL managed instance with this failover group role.
role This property is required. String
The role of the SQL managed instance in this failover group.
partnerMI String
The name of the partner SQL managed instance.
partnerMirroringCert String
The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported.
partnerMirroringURL String
The mirroring endpoint URL of the partner SQL managed instance.
partnerSyncMode String
The partner sync mode of the SQL managed instance.
sharedName String
The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name.
sourceMI String
The name of the SQL managed instance with this failover group role.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native