Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getDistributedAvailabilityGroup
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.sql.getDistributedAvailabilityGroup

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

Gets a distributed availability group info. Azure REST API version: 2021-11-01.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

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>
Copy
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]
Copy
func LookupDistributedAvailabilityGroup(ctx *Context, args *LookupDistributedAvailabilityGroupArgs, opts ...InvokeOption) (*LookupDistributedAvailabilityGroupResult, error)
func LookupDistributedAvailabilityGroupOutput(ctx *Context, args *LookupDistributedAvailabilityGroupOutputArgs, opts ...InvokeOption) LookupDistributedAvailabilityGroupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDistributedAvailabilityGroupResult> getDistributedAvailabilityGroup(GetDistributedAvailabilityGroupArgs args, InvokeOptions options)
public static Output<GetDistributedAvailabilityGroupResult> getDistributedAvailabilityGroup(GetDistributedAvailabilityGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getDistributedAvailabilityGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DistributedAvailabilityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The distributed availability group name.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
DistributedAvailabilityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The distributed availability group name.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
distributedAvailabilityGroupName
This property is required.
Changes to this property will trigger replacement.
String
The distributed availability group name.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
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.
distributedAvailabilityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The distributed availability group name.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
distributed_availability_group_name
This property is required.
Changes to this property will trigger replacement.
str
The distributed availability group name.
managed_instance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the managed instance.
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.
distributedAvailabilityGroupName
This property is required.
Changes to this property will trigger replacement.
String
The distributed availability group name.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
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.

getDistributedAvailabilityGroup Result

The following output properties are available:

DistributedAvailabilityGroupId string
The distributed availability group id
Id string
Resource ID.
LastHardenedLsn string
The last hardened lsn
LinkState string
The link state
Name string
Resource name.
SourceReplicaId string
The source replica id
TargetReplicaId string
The target replica id
Type string
Resource type.
PrimaryAvailabilityGroupName string
The primary availability group name
ReplicationMode string
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
SecondaryAvailabilityGroupName string
The secondary availability group name
SourceEndpoint string
The source endpoint
TargetDatabase string
The name of the target database
DistributedAvailabilityGroupId string
The distributed availability group id
Id string
Resource ID.
LastHardenedLsn string
The last hardened lsn
LinkState string
The link state
Name string
Resource name.
SourceReplicaId string
The source replica id
TargetReplicaId string
The target replica id
Type string
Resource type.
PrimaryAvailabilityGroupName string
The primary availability group name
ReplicationMode string
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
SecondaryAvailabilityGroupName string
The secondary availability group name
SourceEndpoint string
The source endpoint
TargetDatabase string
The name of the target database
distributedAvailabilityGroupId String
The distributed availability group id
id String
Resource ID.
lastHardenedLsn String
The last hardened lsn
linkState String
The link state
name String
Resource name.
sourceReplicaId String
The source replica id
targetReplicaId String
The target replica id
type String
Resource type.
primaryAvailabilityGroupName String
The primary availability group name
replicationMode String
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
secondaryAvailabilityGroupName String
The secondary availability group name
sourceEndpoint String
The source endpoint
targetDatabase String
The name of the target database
distributedAvailabilityGroupId string
The distributed availability group id
id string
Resource ID.
lastHardenedLsn string
The last hardened lsn
linkState string
The link state
name string
Resource name.
sourceReplicaId string
The source replica id
targetReplicaId string
The target replica id
type string
Resource type.
primaryAvailabilityGroupName string
The primary availability group name
replicationMode string
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
secondaryAvailabilityGroupName string
The secondary availability group name
sourceEndpoint string
The source endpoint
targetDatabase string
The name of the target database
distributed_availability_group_id str
The distributed availability group id
id str
Resource ID.
last_hardened_lsn str
The last hardened lsn
link_state str
The link state
name str
Resource name.
source_replica_id str
The source replica id
target_replica_id str
The target replica id
type str
Resource type.
primary_availability_group_name str
The primary availability group name
replication_mode str
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
secondary_availability_group_name str
The secondary availability group name
source_endpoint str
The source endpoint
target_database str
The name of the target database
distributedAvailabilityGroupId String
The distributed availability group id
id String
Resource ID.
lastHardenedLsn String
The last hardened lsn
linkState String
The link state
name String
Resource name.
sourceReplicaId String
The source replica id
targetReplicaId String
The target replica id
type String
Resource type.
primaryAvailabilityGroupName String
The primary availability group name
replicationMode String
The replication mode of a distributed availability group. Parameter will be ignored during link creation.
secondaryAvailabilityGroupName String
The secondary availability group name
sourceEndpoint String
The source endpoint
targetDatabase String
The name of the target database

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