Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getFailoverGroup
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurearcdata.getFailoverGroup

Explore with Pulumi AI

azure-native logo
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.89.1 published on Sunday, Mar 2, 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>
    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]
    func LookupFailoverGroup(ctx *Context, args *LookupFailoverGroupArgs, opts ...InvokeOption) (*LookupFailoverGroupResult, error)
func LookupFailoverGroupOutput(ctx *Context, args *LookupFailoverGroupOutputArgs, opts ...InvokeOption) LookupFailoverGroupResultOutput

    > 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)
}
    public static CompletableFuture<GetFailoverGroupResult> getFailoverGroup(GetFailoverGroupArgs args, InvokeOptions options)
public static Output<GetFailoverGroupResult> getFailoverGroup(GetFailoverGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurearcdata:getFailoverGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FailoverGroupName string
    The name of the Failover Group
    ResourceGroupName string
    The name of the Azure resource group
    SqlManagedInstanceName string
    Name of SQL Managed Instance
    FailoverGroupName string
    The name of the Failover Group
    ResourceGroupName string
    The name of the Azure resource group
    SqlManagedInstanceName string
    Name of SQL Managed Instance
    failoverGroupName String
    The name of the Failover Group
    resourceGroupName String
    The name of the Azure resource group
    sqlManagedInstanceName String
    Name of SQL Managed Instance
    failoverGroupName string
    The name of the Failover Group
    resourceGroupName string
    The name of the Azure resource group
    sqlManagedInstanceName string
    Name of SQL Managed Instance
    failover_group_name str
    The name of the Failover Group
    resource_group_name str
    The name of the Azure resource group
    sql_managed_instance_name str
    Name of SQL Managed Instance
    failoverGroupName String
    The name of the Failover Group
    resourceGroupName String
    The name of the Azure resource group
    sqlManagedInstanceName 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 string
    The resource ID of the partner SQL managed instance.
    ProvisioningState string
    The provisioning state of the failover group resource.
    Spec Pulumi.AzureNative.AzureArcData.Inputs.FailoverGroupSpecResponse
    The specifications of the failover group resource.
    Status object
    The status of the failover group custom resource.
    PartnerManagedInstanceId string
    The resource ID of the partner SQL managed instance.
    ProvisioningState string
    The provisioning state of the failover group resource.
    Spec FailoverGroupSpecResponse
    The specifications of the failover group resource.
    Status interface{}
    The status of the failover group custom resource.
    partnerManagedInstanceId String
    The resource ID of the partner SQL managed instance.
    provisioningState String
    The provisioning state of the failover group resource.
    spec FailoverGroupSpecResponse
    The specifications of the failover group resource.
    status Object
    The status of the failover group custom resource.
    partnerManagedInstanceId string
    The resource ID of the partner SQL managed instance.
    provisioningState string
    The provisioning state of the failover group resource.
    spec FailoverGroupSpecResponse
    The specifications of the failover group resource.
    status any
    The status of the failover group custom resource.
    partner_managed_instance_id str
    The resource ID of the partner SQL managed instance.
    provisioning_state str
    The provisioning state of the failover group resource.
    spec FailoverGroupSpecResponse
    The specifications of the failover group resource.
    status Any
    The status of the failover group custom resource.
    partnerManagedInstanceId String
    The resource ID of the partner SQL managed instance.
    provisioningState String
    The provisioning state of the failover group resource.
    spec Property Map
    The specifications of the failover group resource.
    status Any
    The status of the failover group custom resource.

    FailoverGroupSpecResponse

    Role 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 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 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 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 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 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native