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

azure-native.sql.getDistributedAvailabilityGroup

Explore with Pulumi AI

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

    Gets a distributed availability group info.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 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 getDistributedAvailabilityGroup

    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 getDistributedAvailabilityGroup(args: GetDistributedAvailabilityGroupArgs, opts?: InvokeOptions): Promise<GetDistributedAvailabilityGroupResult>
function getDistributedAvailabilityGroupOutput(args: GetDistributedAvailabilityGroupOutputArgs, opts?: InvokeOptions): Output<GetDistributedAvailabilityGroupResult>
    def get_distributed_availability_group(distributed_availability_group_name: Optional[str] = None,
                                       managed_instance_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDistributedAvailabilityGroupResult
def get_distributed_availability_group_output(distributed_availability_group_name: Optional[pulumi.Input[str]] = None,
                                       managed_instance_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDistributedAvailabilityGroupResult]
    func LookupDistributedAvailabilityGroup(ctx *Context, args *LookupDistributedAvailabilityGroupArgs, opts ...InvokeOption) (*LookupDistributedAvailabilityGroupResult, error)
func LookupDistributedAvailabilityGroupOutput(ctx *Context, args *LookupDistributedAvailabilityGroupOutputArgs, opts ...InvokeOption) LookupDistributedAvailabilityGroupResultOutput

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

    public static class GetDistributedAvailabilityGroup 
{
    public static Task<GetDistributedAvailabilityGroupResult> InvokeAsync(GetDistributedAvailabilityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDistributedAvailabilityGroupResult> Invoke(GetDistributedAvailabilityGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDistributedAvailabilityGroupResult> getDistributedAvailabilityGroup(GetDistributedAvailabilityGroupArgs args, InvokeOptions options)
public static Output<GetDistributedAvailabilityGroupResult> getDistributedAvailabilityGroup(GetDistributedAvailabilityGroupArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DistributedAvailabilityGroupName string
    The distributed availability group name.
    ManagedInstanceName string
    The name of the managed instance.
    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.
    DistributedAvailabilityGroupName string
    The distributed availability group name.
    ManagedInstanceName string
    The name of the managed instance.
    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.
    distributedAvailabilityGroupName String
    The distributed availability group name.
    managedInstanceName String
    The name of the managed instance.
    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.
    distributedAvailabilityGroupName string
    The distributed availability group name.
    managedInstanceName string
    The name of the managed instance.
    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.
    distributed_availability_group_name str
    The distributed availability group name.
    managed_instance_name str
    The name of the managed instance.
    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.
    distributedAvailabilityGroupName String
    The distributed availability group name.
    managedInstanceName String
    The name of the managed instance.
    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.

    getDistributedAvailabilityGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DistributedAvailabilityGroupId string
    ID of the distributed availability group
    DistributedAvailabilityGroupName string
    Name of the distributed availability group
    Id string
    Resource ID.
    Name string
    Resource name.
    PartnerLinkRole string
    SQL server side link role
    Type string
    Resource type.
    Databases List<Pulumi.AzureNative.Sql.Outputs.DistributedAvailabilityGroupDatabaseResponse>
    Databases in the distributed availability group
    FailoverMode string
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    InstanceAvailabilityGroupName string
    Managed instance side availability group name
    InstanceLinkRole string
    Managed instance side link role
    PartnerAvailabilityGroupName string
    SQL server side availability group name
    PartnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    ReplicationMode string
    Replication mode of the link
    SeedingMode string
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    AzureApiVersion string
    The Azure API version of the resource.
    DistributedAvailabilityGroupId string
    ID of the distributed availability group
    DistributedAvailabilityGroupName string
    Name of the distributed availability group
    Id string
    Resource ID.
    Name string
    Resource name.
    PartnerLinkRole string
    SQL server side link role
    Type string
    Resource type.
    Databases []DistributedAvailabilityGroupDatabaseResponse
    Databases in the distributed availability group
    FailoverMode string
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    InstanceAvailabilityGroupName string
    Managed instance side availability group name
    InstanceLinkRole string
    Managed instance side link role
    PartnerAvailabilityGroupName string
    SQL server side availability group name
    PartnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    ReplicationMode string
    Replication mode of the link
    SeedingMode string
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    azureApiVersion String
    The Azure API version of the resource.
    distributedAvailabilityGroupId String
    ID of the distributed availability group
    distributedAvailabilityGroupName String
    Name of the distributed availability group
    id String
    Resource ID.
    name String
    Resource name.
    partnerLinkRole String
    SQL server side link role
    type String
    Resource type.
    databases List<DistributedAvailabilityGroupDatabaseResponse>
    Databases in the distributed availability group
    failoverMode String
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName String
    Managed instance side availability group name
    instanceLinkRole String
    Managed instance side link role
    partnerAvailabilityGroupName String
    SQL server side availability group name
    partnerEndpoint String
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode String
    Replication mode of the link
    seedingMode String
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    azureApiVersion string
    The Azure API version of the resource.
    distributedAvailabilityGroupId string
    ID of the distributed availability group
    distributedAvailabilityGroupName string
    Name of the distributed availability group
    id string
    Resource ID.
    name string
    Resource name.
    partnerLinkRole string
    SQL server side link role
    type string
    Resource type.
    databases DistributedAvailabilityGroupDatabaseResponse[]
    Databases in the distributed availability group
    failoverMode string
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName string
    Managed instance side availability group name
    instanceLinkRole string
    Managed instance side link role
    partnerAvailabilityGroupName string
    SQL server side availability group name
    partnerEndpoint string
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode string
    Replication mode of the link
    seedingMode string
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    azure_api_version str
    The Azure API version of the resource.
    distributed_availability_group_id str
    ID of the distributed availability group
    distributed_availability_group_name str
    Name of the distributed availability group
    id str
    Resource ID.
    name str
    Resource name.
    partner_link_role str
    SQL server side link role
    type str
    Resource type.
    databases Sequence[DistributedAvailabilityGroupDatabaseResponse]
    Databases in the distributed availability group
    failover_mode str
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instance_availability_group_name str
    Managed instance side availability group name
    instance_link_role str
    Managed instance side link role
    partner_availability_group_name str
    SQL server side availability group name
    partner_endpoint str
    SQL server side endpoint - IP or DNS resolvable name
    replication_mode str
    Replication mode of the link
    seeding_mode str
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.
    azureApiVersion String
    The Azure API version of the resource.
    distributedAvailabilityGroupId String
    ID of the distributed availability group
    distributedAvailabilityGroupName String
    Name of the distributed availability group
    id String
    Resource ID.
    name String
    Resource name.
    partnerLinkRole String
    SQL server side link role
    type String
    Resource type.
    databases List<Property Map>
    Databases in the distributed availability group
    failoverMode String
    The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure.
    instanceAvailabilityGroupName String
    Managed instance side availability group name
    instanceLinkRole String
    Managed instance side link role
    partnerAvailabilityGroupName String
    SQL server side availability group name
    partnerEndpoint String
    SQL server side endpoint - IP or DNS resolvable name
    replicationMode String
    Replication mode of the link
    seedingMode String
    Database seeding mode – can be Automatic (default), or Manual for supported scenarios.

    Supporting Types

    CertificateInfoResponse

    CertificateName string
    The certificate name
    ExpiryDate string
    The certificate expiry date
    CertificateName string
    The certificate name
    ExpiryDate string
    The certificate expiry date
    certificateName String
    The certificate name
    expiryDate String
    The certificate expiry date
    certificateName string
    The certificate name
    expiryDate string
    The certificate expiry date
    certificate_name str
    The certificate name
    expiry_date str
    The certificate expiry date
    certificateName String
    The certificate name
    expiryDate String
    The certificate expiry date

    DistributedAvailabilityGroupDatabaseResponse

    ConnectedState string
    Link connected state
    InstanceRedoReplicationLagSeconds int
    Redo lag when Managed Instance link side is primary
    InstanceReplicaId string
    Managed instance replica id
    InstanceSendReplicationLagSeconds int
    Replication lag when Managed Instance link side is primary
    LastBackupLsn string
    Last backup LSN
    LastBackupTime string
    Last backup LSN time
    LastCommitLsn string
    Last commit LSN
    LastCommitTime string
    Last commit LSN time
    LastHardenedLsn string
    Last hardened LSN
    LastHardenedTime string
    Last hardened LSN time
    LastReceivedLsn string
    Last received LSN
    LastReceivedTime string
    Last received LSN time
    LastSentLsn string
    Last sent LSN
    LastSentTime string
    Last sent LSN time
    MostRecentLinkError string
    The most recent link connection error description
    PartnerAuthCertValidity Pulumi.AzureNative.Sql.Inputs.CertificateInfoResponse
    SQL server certificate validity
    PartnerReplicaId string
    SQL server replica id
    ReplicaState string
    Current link state
    SeedingProgress string
    Seeding progress
    SynchronizationHealth string
    Link health state
    DatabaseName string
    The name of the database in link
    ConnectedState string
    Link connected state
    InstanceRedoReplicationLagSeconds int
    Redo lag when Managed Instance link side is primary
    InstanceReplicaId string
    Managed instance replica id
    InstanceSendReplicationLagSeconds int
    Replication lag when Managed Instance link side is primary
    LastBackupLsn string
    Last backup LSN
    LastBackupTime string
    Last backup LSN time
    LastCommitLsn string
    Last commit LSN
    LastCommitTime string
    Last commit LSN time
    LastHardenedLsn string
    Last hardened LSN
    LastHardenedTime string
    Last hardened LSN time
    LastReceivedLsn string
    Last received LSN
    LastReceivedTime string
    Last received LSN time
    LastSentLsn string
    Last sent LSN
    LastSentTime string
    Last sent LSN time
    MostRecentLinkError string
    The most recent link connection error description
    PartnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    PartnerReplicaId string
    SQL server replica id
    ReplicaState string
    Current link state
    SeedingProgress string
    Seeding progress
    SynchronizationHealth string
    Link health state
    DatabaseName string
    The name of the database in link
    connectedState String
    Link connected state
    instanceRedoReplicationLagSeconds Integer
    Redo lag when Managed Instance link side is primary
    instanceReplicaId String
    Managed instance replica id
    instanceSendReplicationLagSeconds Integer
    Replication lag when Managed Instance link side is primary
    lastBackupLsn String
    Last backup LSN
    lastBackupTime String
    Last backup LSN time
    lastCommitLsn String
    Last commit LSN
    lastCommitTime String
    Last commit LSN time
    lastHardenedLsn String
    Last hardened LSN
    lastHardenedTime String
    Last hardened LSN time
    lastReceivedLsn String
    Last received LSN
    lastReceivedTime String
    Last received LSN time
    lastSentLsn String
    Last sent LSN
    lastSentTime String
    Last sent LSN time
    mostRecentLinkError String
    The most recent link connection error description
    partnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    partnerReplicaId String
    SQL server replica id
    replicaState String
    Current link state
    seedingProgress String
    Seeding progress
    synchronizationHealth String
    Link health state
    databaseName String
    The name of the database in link
    connectedState string
    Link connected state
    instanceRedoReplicationLagSeconds number
    Redo lag when Managed Instance link side is primary
    instanceReplicaId string
    Managed instance replica id
    instanceSendReplicationLagSeconds number
    Replication lag when Managed Instance link side is primary
    lastBackupLsn string
    Last backup LSN
    lastBackupTime string
    Last backup LSN time
    lastCommitLsn string
    Last commit LSN
    lastCommitTime string
    Last commit LSN time
    lastHardenedLsn string
    Last hardened LSN
    lastHardenedTime string
    Last hardened LSN time
    lastReceivedLsn string
    Last received LSN
    lastReceivedTime string
    Last received LSN time
    lastSentLsn string
    Last sent LSN
    lastSentTime string
    Last sent LSN time
    mostRecentLinkError string
    The most recent link connection error description
    partnerAuthCertValidity CertificateInfoResponse
    SQL server certificate validity
    partnerReplicaId string
    SQL server replica id
    replicaState string
    Current link state
    seedingProgress string
    Seeding progress
    synchronizationHealth string
    Link health state
    databaseName string
    The name of the database in link
    connected_state str
    Link connected state
    instance_redo_replication_lag_seconds int
    Redo lag when Managed Instance link side is primary
    instance_replica_id str
    Managed instance replica id
    instance_send_replication_lag_seconds int
    Replication lag when Managed Instance link side is primary
    last_backup_lsn str
    Last backup LSN
    last_backup_time str
    Last backup LSN time
    last_commit_lsn str
    Last commit LSN
    last_commit_time str
    Last commit LSN time
    last_hardened_lsn str
    Last hardened LSN
    last_hardened_time str
    Last hardened LSN time
    last_received_lsn str
    Last received LSN
    last_received_time str
    Last received LSN time
    last_sent_lsn str
    Last sent LSN
    last_sent_time str
    Last sent LSN time
    most_recent_link_error str
    The most recent link connection error description
    partner_auth_cert_validity CertificateInfoResponse
    SQL server certificate validity
    partner_replica_id str
    SQL server replica id
    replica_state str
    Current link state
    seeding_progress str
    Seeding progress
    synchronization_health str
    Link health state
    database_name str
    The name of the database in link
    connectedState String
    Link connected state
    instanceRedoReplicationLagSeconds Number
    Redo lag when Managed Instance link side is primary
    instanceReplicaId String
    Managed instance replica id
    instanceSendReplicationLagSeconds Number
    Replication lag when Managed Instance link side is primary
    lastBackupLsn String
    Last backup LSN
    lastBackupTime String
    Last backup LSN time
    lastCommitLsn String
    Last commit LSN
    lastCommitTime String
    Last commit LSN time
    lastHardenedLsn String
    Last hardened LSN
    lastHardenedTime String
    Last hardened LSN time
    lastReceivedLsn String
    Last received LSN
    lastReceivedTime String
    Last received LSN time
    lastSentLsn String
    Last sent LSN
    lastSentTime String
    Last sent LSN time
    mostRecentLinkError String
    The most recent link connection error description
    partnerAuthCertValidity Property Map
    SQL server certificate validity
    partnerReplicaId String
    SQL server replica id
    replicaState String
    Current link state
    seedingProgress String
    Seeding progress
    synchronizationHealth String
    Link health state
    databaseName String
    The name of the database in link

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native