Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getSqlServerAvailabilityGroup
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurearcdata.getSqlServerAvailabilityGroup

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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves an Arc Sql Server availability group.

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2024-05-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurearcdata [ApiVersion]. See the version guide for details.

    Using getSqlServerAvailabilityGroup

    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 getSqlServerAvailabilityGroup(args: GetSqlServerAvailabilityGroupArgs, opts?: InvokeOptions): Promise<GetSqlServerAvailabilityGroupResult>
function getSqlServerAvailabilityGroupOutput(args: GetSqlServerAvailabilityGroupOutputArgs, opts?: InvokeOptions): Output<GetSqlServerAvailabilityGroupResult>
    def get_sql_server_availability_group(availability_group_name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      sql_server_instance_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetSqlServerAvailabilityGroupResult
def get_sql_server_availability_group_output(availability_group_name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      sql_server_instance_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetSqlServerAvailabilityGroupResult]
    func LookupSqlServerAvailabilityGroup(ctx *Context, args *LookupSqlServerAvailabilityGroupArgs, opts ...InvokeOption) (*LookupSqlServerAvailabilityGroupResult, error)
func LookupSqlServerAvailabilityGroupOutput(ctx *Context, args *LookupSqlServerAvailabilityGroupOutputArgs, opts ...InvokeOption) LookupSqlServerAvailabilityGroupResultOutput

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

    public static class GetSqlServerAvailabilityGroup 
{
    public static Task<GetSqlServerAvailabilityGroupResult> InvokeAsync(GetSqlServerAvailabilityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlServerAvailabilityGroupResult> Invoke(GetSqlServerAvailabilityGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSqlServerAvailabilityGroupResult> getSqlServerAvailabilityGroup(GetSqlServerAvailabilityGroupArgs args, InvokeOptions options)
public static Output<GetSqlServerAvailabilityGroupResult> getSqlServerAvailabilityGroup(GetSqlServerAvailabilityGroupArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AvailabilityGroupName string
    Name of SQL Availability Group
    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    AvailabilityGroupName string
    Name of SQL Availability Group
    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    availabilityGroupName String
    Name of SQL Availability Group
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance
    availabilityGroupName string
    Name of SQL Availability Group
    resourceGroupName string
    The name of the Azure resource group
    sqlServerInstanceName string
    Name of SQL Server Instance
    availability_group_name str
    Name of SQL Availability Group
    resource_group_name str
    The name of the Azure resource group
    sql_server_instance_name str
    Name of SQL Server Instance
    availabilityGroupName String
    Name of SQL Availability Group
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance

    getSqlServerAvailabilityGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureArcData.Outputs.SqlServerAvailabilityGroupResourcePropertiesResponse
    Properties of Arc Sql Server availability group
    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"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties SqlServerAvailabilityGroupResourcePropertiesResponse
    Properties of Arc Sql Server availability group
    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"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties SqlServerAvailabilityGroupResourcePropertiesResponse
    Properties of Arc Sql Server availability group
    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"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties SqlServerAvailabilityGroupResourcePropertiesResponse
    Properties of Arc Sql Server availability group
    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"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties SqlServerAvailabilityGroupResourcePropertiesResponse
    Properties of Arc Sql Server availability group
    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"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    Properties of Arc Sql Server availability group
    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"
    tags Map<String>
    Resource tags.

    Supporting Types

    AvailabilityGroupConfigureResponse

    AvailabilityModeDescription string
    The Availability Synchronization mode of the availability group replica.
    FailoverModeDescription string
    The failover mode of the availability group replica.
    PrimaryRoleAllowConnectionsDescription string
    Whether the availability allows all connections or only read-write connections.
    ReplicaCreateDate string
    Date that the replica was created.
    ReplicaModifyDate string
    Date that the replica was modified.
    SecondaryRoleAllowConnectionsDescription string
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    SeedingModeDescription string
    Describes seeding mode.
    BackupPriority int
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    EndpointUrl string
    Mirroring endpoint URL of availability group replica
    ReadOnlyRoutingUrl string
    Connectivity endpoint (URL) of the read only availability replica.
    ReadWriteRoutingUrl string
    Connectivity endpoint (URL) of the read write availability replica.
    SessionTimeout int
    The time-out period of availability group session replica, in seconds.
    AvailabilityModeDescription string
    The Availability Synchronization mode of the availability group replica.
    FailoverModeDescription string
    The failover mode of the availability group replica.
    PrimaryRoleAllowConnectionsDescription string
    Whether the availability allows all connections or only read-write connections.
    ReplicaCreateDate string
    Date that the replica was created.
    ReplicaModifyDate string
    Date that the replica was modified.
    SecondaryRoleAllowConnectionsDescription string
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    SeedingModeDescription string
    Describes seeding mode.
    BackupPriority int
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    EndpointUrl string
    Mirroring endpoint URL of availability group replica
    ReadOnlyRoutingUrl string
    Connectivity endpoint (URL) of the read only availability replica.
    ReadWriteRoutingUrl string
    Connectivity endpoint (URL) of the read write availability replica.
    SessionTimeout int
    The time-out period of availability group session replica, in seconds.
    availabilityModeDescription String
    The Availability Synchronization mode of the availability group replica.
    failoverModeDescription String
    The failover mode of the availability group replica.
    primaryRoleAllowConnectionsDescription String
    Whether the availability allows all connections or only read-write connections.
    replicaCreateDate String
    Date that the replica was created.
    replicaModifyDate String
    Date that the replica was modified.
    secondaryRoleAllowConnectionsDescription String
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    seedingModeDescription String
    Describes seeding mode.
    backupPriority Integer
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    endpointUrl String
    Mirroring endpoint URL of availability group replica
    readOnlyRoutingUrl String
    Connectivity endpoint (URL) of the read only availability replica.
    readWriteRoutingUrl String
    Connectivity endpoint (URL) of the read write availability replica.
    sessionTimeout Integer
    The time-out period of availability group session replica, in seconds.
    availabilityModeDescription string
    The Availability Synchronization mode of the availability group replica.
    failoverModeDescription string
    The failover mode of the availability group replica.
    primaryRoleAllowConnectionsDescription string
    Whether the availability allows all connections or only read-write connections.
    replicaCreateDate string
    Date that the replica was created.
    replicaModifyDate string
    Date that the replica was modified.
    secondaryRoleAllowConnectionsDescription string
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    seedingModeDescription string
    Describes seeding mode.
    backupPriority number
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    endpointUrl string
    Mirroring endpoint URL of availability group replica
    readOnlyRoutingUrl string
    Connectivity endpoint (URL) of the read only availability replica.
    readWriteRoutingUrl string
    Connectivity endpoint (URL) of the read write availability replica.
    sessionTimeout number
    The time-out period of availability group session replica, in seconds.
    availability_mode_description str
    The Availability Synchronization mode of the availability group replica.
    failover_mode_description str
    The failover mode of the availability group replica.
    primary_role_allow_connections_description str
    Whether the availability allows all connections or only read-write connections.
    replica_create_date str
    Date that the replica was created.
    replica_modify_date str
    Date that the replica was modified.
    secondary_role_allow_connections_description str
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    seeding_mode_description str
    Describes seeding mode.
    backup_priority int
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    endpoint_url str
    Mirroring endpoint URL of availability group replica
    read_only_routing_url str
    Connectivity endpoint (URL) of the read only availability replica.
    read_write_routing_url str
    Connectivity endpoint (URL) of the read write availability replica.
    session_timeout int
    The time-out period of availability group session replica, in seconds.
    availabilityModeDescription String
    The Availability Synchronization mode of the availability group replica.
    failoverModeDescription String
    The failover mode of the availability group replica.
    primaryRoleAllowConnectionsDescription String
    Whether the availability allows all connections or only read-write connections.
    replicaCreateDate String
    Date that the replica was created.
    replicaModifyDate String
    Date that the replica was modified.
    secondaryRoleAllowConnectionsDescription String
    Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
    seedingModeDescription String
    Describes seeding mode.
    backupPriority Number
    Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.
    endpointUrl String
    Mirroring endpoint URL of availability group replica
    readOnlyRoutingUrl String
    Connectivity endpoint (URL) of the read only availability replica.
    readWriteRoutingUrl String
    Connectivity endpoint (URL) of the read write availability replica.
    sessionTimeout Number
    The time-out period of availability group session replica, in seconds.

    AvailabilityGroupInfoResponse

    AutomatedBackupPreferenceDescription string
    Preferred location for performing backups on the availability databases in this availability group.
    ClusterTypeDescription string
    SQL Server availability group cluster type description
    PrimaryRecoveryHealthDescription string
    Indicates the recovery health of the primary replica.
    PrimaryReplica string
    Name of the server instance that is hosting the current primary replica.
    ReplicationPartnerType string
    SecondaryRecoveryHealthDescription string
    Indicates the recovery health of a secondary replica.
    SynchronizationHealthDescription string
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    Version int
    SQL Server availability group current version.
    BasicFeatures bool
    Specifies whether this is a basic availability group.
    DbFailover bool
    Specifies whether the availability group supports failover for database health conditions.
    DtcSupport bool
    Specifies whether DTC support has been enabled for this availability group.
    FailureConditionLevel int
    User-defined failure condition level under which an automatic failover must be triggered.
    HealthCheckTimeout int
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    IsContained bool
    SQL Server availability group contained system databases.
    IsDistributed bool
    Specifies whether this is a distributed availability group.
    RequiredSynchronizedSecondariesToCommit int
    The number of secondary replicas that must be in a synchronized state for a commit to complete.
    AutomatedBackupPreferenceDescription string
    Preferred location for performing backups on the availability databases in this availability group.
    ClusterTypeDescription string
    SQL Server availability group cluster type description
    PrimaryRecoveryHealthDescription string
    Indicates the recovery health of the primary replica.
    PrimaryReplica string
    Name of the server instance that is hosting the current primary replica.
    ReplicationPartnerType string
    SecondaryRecoveryHealthDescription string
    Indicates the recovery health of a secondary replica.
    SynchronizationHealthDescription string
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    Version int
    SQL Server availability group current version.
    BasicFeatures bool
    Specifies whether this is a basic availability group.
    DbFailover bool
    Specifies whether the availability group supports failover for database health conditions.
    DtcSupport bool
    Specifies whether DTC support has been enabled for this availability group.
    FailureConditionLevel int
    User-defined failure condition level under which an automatic failover must be triggered.
    HealthCheckTimeout int
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    IsContained bool
    SQL Server availability group contained system databases.
    IsDistributed bool
    Specifies whether this is a distributed availability group.
    RequiredSynchronizedSecondariesToCommit int
    The number of secondary replicas that must be in a synchronized state for a commit to complete.
    automatedBackupPreferenceDescription String
    Preferred location for performing backups on the availability databases in this availability group.
    clusterTypeDescription String
    SQL Server availability group cluster type description
    primaryRecoveryHealthDescription String
    Indicates the recovery health of the primary replica.
    primaryReplica String
    Name of the server instance that is hosting the current primary replica.
    replicationPartnerType String
    secondaryRecoveryHealthDescription String
    Indicates the recovery health of a secondary replica.
    synchronizationHealthDescription String
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    version Integer
    SQL Server availability group current version.
    basicFeatures Boolean
    Specifies whether this is a basic availability group.
    dbFailover Boolean
    Specifies whether the availability group supports failover for database health conditions.
    dtcSupport Boolean
    Specifies whether DTC support has been enabled for this availability group.
    failureConditionLevel Integer
    User-defined failure condition level under which an automatic failover must be triggered.
    healthCheckTimeout Integer
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    isContained Boolean
    SQL Server availability group contained system databases.
    isDistributed Boolean
    Specifies whether this is a distributed availability group.
    requiredSynchronizedSecondariesToCommit Integer
    The number of secondary replicas that must be in a synchronized state for a commit to complete.
    automatedBackupPreferenceDescription string
    Preferred location for performing backups on the availability databases in this availability group.
    clusterTypeDescription string
    SQL Server availability group cluster type description
    primaryRecoveryHealthDescription string
    Indicates the recovery health of the primary replica.
    primaryReplica string
    Name of the server instance that is hosting the current primary replica.
    replicationPartnerType string
    secondaryRecoveryHealthDescription string
    Indicates the recovery health of a secondary replica.
    synchronizationHealthDescription string
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    version number
    SQL Server availability group current version.
    basicFeatures boolean
    Specifies whether this is a basic availability group.
    dbFailover boolean
    Specifies whether the availability group supports failover for database health conditions.
    dtcSupport boolean
    Specifies whether DTC support has been enabled for this availability group.
    failureConditionLevel number
    User-defined failure condition level under which an automatic failover must be triggered.
    healthCheckTimeout number
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    isContained boolean
    SQL Server availability group contained system databases.
    isDistributed boolean
    Specifies whether this is a distributed availability group.
    requiredSynchronizedSecondariesToCommit number
    The number of secondary replicas that must be in a synchronized state for a commit to complete.
    automated_backup_preference_description str
    Preferred location for performing backups on the availability databases in this availability group.
    cluster_type_description str
    SQL Server availability group cluster type description
    primary_recovery_health_description str
    Indicates the recovery health of the primary replica.
    primary_replica str
    Name of the server instance that is hosting the current primary replica.
    replication_partner_type str
    secondary_recovery_health_description str
    Indicates the recovery health of a secondary replica.
    synchronization_health_description str
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    version int
    SQL Server availability group current version.
    basic_features bool
    Specifies whether this is a basic availability group.
    db_failover bool
    Specifies whether the availability group supports failover for database health conditions.
    dtc_support bool
    Specifies whether DTC support has been enabled for this availability group.
    failure_condition_level int
    User-defined failure condition level under which an automatic failover must be triggered.
    health_check_timeout int
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    is_contained bool
    SQL Server availability group contained system databases.
    is_distributed bool
    Specifies whether this is a distributed availability group.
    required_synchronized_secondaries_to_commit int
    The number of secondary replicas that must be in a synchronized state for a commit to complete.
    automatedBackupPreferenceDescription String
    Preferred location for performing backups on the availability databases in this availability group.
    clusterTypeDescription String
    SQL Server availability group cluster type description
    primaryRecoveryHealthDescription String
    Indicates the recovery health of the primary replica.
    primaryReplica String
    Name of the server instance that is hosting the current primary replica.
    replicationPartnerType String
    secondaryRecoveryHealthDescription String
    Indicates the recovery health of a secondary replica.
    synchronizationHealthDescription String
    Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
    version Number
    SQL Server availability group current version.
    basicFeatures Boolean
    Specifies whether this is a basic availability group.
    dbFailover Boolean
    Specifies whether the availability group supports failover for database health conditions.
    dtcSupport Boolean
    Specifies whether DTC support has been enabled for this availability group.
    failureConditionLevel Number
    User-defined failure condition level under which an automatic failover must be triggered.
    healthCheckTimeout Number
    Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.
    isContained Boolean
    SQL Server availability group contained system databases.
    isDistributed Boolean
    Specifies whether this is a distributed availability group.
    requiredSynchronizedSecondariesToCommit Number
    The number of secondary replicas that must be in a synchronized state for a commit to complete.

    AvailabilityGroupStateResponse

    AvailabilityGroupReplicaRole string
    Current Always On availability groups role of the availability group replica.
    ConnectedStateDescription string
    Whether a secondary replica is currently connected to the primary replica.
    LastConnectErrorDescription string
    Text description of the last connection error of the availability group replica.
    LastConnectErrorTimestamp string
    Date and time timestamp indicating when the last connect error occurred.
    OperationalStateDescription string
    Current operational state of the availability group replica
    RecoveryHealthDescription string
    Recovery health of the availability group replica.
    SynchronizationHealthDescription string
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.
    AvailabilityGroupReplicaRole string
    Current Always On availability groups role of the availability group replica.
    ConnectedStateDescription string
    Whether a secondary replica is currently connected to the primary replica.
    LastConnectErrorDescription string
    Text description of the last connection error of the availability group replica.
    LastConnectErrorTimestamp string
    Date and time timestamp indicating when the last connect error occurred.
    OperationalStateDescription string
    Current operational state of the availability group replica
    RecoveryHealthDescription string
    Recovery health of the availability group replica.
    SynchronizationHealthDescription string
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.
    availabilityGroupReplicaRole String
    Current Always On availability groups role of the availability group replica.
    connectedStateDescription String
    Whether a secondary replica is currently connected to the primary replica.
    lastConnectErrorDescription String
    Text description of the last connection error of the availability group replica.
    lastConnectErrorTimestamp String
    Date and time timestamp indicating when the last connect error occurred.
    operationalStateDescription String
    Current operational state of the availability group replica
    recoveryHealthDescription String
    Recovery health of the availability group replica.
    synchronizationHealthDescription String
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.
    availabilityGroupReplicaRole string
    Current Always On availability groups role of the availability group replica.
    connectedStateDescription string
    Whether a secondary replica is currently connected to the primary replica.
    lastConnectErrorDescription string
    Text description of the last connection error of the availability group replica.
    lastConnectErrorTimestamp string
    Date and time timestamp indicating when the last connect error occurred.
    operationalStateDescription string
    Current operational state of the availability group replica
    recoveryHealthDescription string
    Recovery health of the availability group replica.
    synchronizationHealthDescription string
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.
    availability_group_replica_role str
    Current Always On availability groups role of the availability group replica.
    connected_state_description str
    Whether a secondary replica is currently connected to the primary replica.
    last_connect_error_description str
    Text description of the last connection error of the availability group replica.
    last_connect_error_timestamp str
    Date and time timestamp indicating when the last connect error occurred.
    operational_state_description str
    Current operational state of the availability group replica
    recovery_health_description str
    Recovery health of the availability group replica.
    synchronization_health_description str
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.
    availabilityGroupReplicaRole String
    Current Always On availability groups role of the availability group replica.
    connectedStateDescription String
    Whether a secondary replica is currently connected to the primary replica.
    lastConnectErrorDescription String
    Text description of the last connection error of the availability group replica.
    lastConnectErrorTimestamp String
    Date and time timestamp indicating when the last connect error occurred.
    operationalStateDescription String
    Current operational state of the availability group replica
    recoveryHealthDescription String
    Recovery health of the availability group replica.
    synchronizationHealthDescription String
    Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.

    SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse

    DatabaseStateDescription string
    Description of the database state of the availability replica.
    IsCommitParticipant bool
    Whether this replica is transaction committer.
    IsLocal bool
    Whether the availability database is local.
    IsPrimaryReplica bool
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    IsSuspended bool
    Whether this data movement is suspended.
    ReplicaName string
    the database replica name.
    SuspendReasonDescription string
    Description of the database suspended state reason.
    SynchronizationHealthDescription string
    Description of the health of database.
    SynchronizationStateDescription string
    Description of the data-movement state.
    DatabaseName string
    the database name.
    DatabaseStateDescription string
    Description of the database state of the availability replica.
    IsCommitParticipant bool
    Whether this replica is transaction committer.
    IsLocal bool
    Whether the availability database is local.
    IsPrimaryReplica bool
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    IsSuspended bool
    Whether this data movement is suspended.
    ReplicaName string
    the database replica name.
    SuspendReasonDescription string
    Description of the database suspended state reason.
    SynchronizationHealthDescription string
    Description of the health of database.
    SynchronizationStateDescription string
    Description of the data-movement state.
    DatabaseName string
    the database name.
    databaseStateDescription String
    Description of the database state of the availability replica.
    isCommitParticipant Boolean
    Whether this replica is transaction committer.
    isLocal Boolean
    Whether the availability database is local.
    isPrimaryReplica Boolean
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    isSuspended Boolean
    Whether this data movement is suspended.
    replicaName String
    the database replica name.
    suspendReasonDescription String
    Description of the database suspended state reason.
    synchronizationHealthDescription String
    Description of the health of database.
    synchronizationStateDescription String
    Description of the data-movement state.
    databaseName String
    the database name.
    databaseStateDescription string
    Description of the database state of the availability replica.
    isCommitParticipant boolean
    Whether this replica is transaction committer.
    isLocal boolean
    Whether the availability database is local.
    isPrimaryReplica boolean
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    isSuspended boolean
    Whether this data movement is suspended.
    replicaName string
    the database replica name.
    suspendReasonDescription string
    Description of the database suspended state reason.
    synchronizationHealthDescription string
    Description of the health of database.
    synchronizationStateDescription string
    Description of the data-movement state.
    databaseName string
    the database name.
    database_state_description str
    Description of the database state of the availability replica.
    is_commit_participant bool
    Whether this replica is transaction committer.
    is_local bool
    Whether the availability database is local.
    is_primary_replica bool
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    is_suspended bool
    Whether this data movement is suspended.
    replica_name str
    the database replica name.
    suspend_reason_description str
    Description of the database suspended state reason.
    synchronization_health_description str
    Description of the health of database.
    synchronization_state_description str
    Description of the data-movement state.
    database_name str
    the database name.
    databaseStateDescription String
    Description of the database state of the availability replica.
    isCommitParticipant Boolean
    Whether this replica is transaction committer.
    isLocal Boolean
    Whether the availability database is local.
    isPrimaryReplica Boolean
    Returns 1 if the replica is primary, or 0 if it is a secondary replica.
    isSuspended Boolean
    Whether this data movement is suspended.
    replicaName String
    the database replica name.
    suspendReasonDescription String
    Description of the database suspended state reason.
    synchronizationHealthDescription String
    Description of the health of database.
    synchronizationStateDescription String
    Description of the data-movement state.
    databaseName String
    the database name.

    SqlAvailabilityGroupReplicaResourcePropertiesResponse

    ReplicaId string
    ID GUID of the availability group.
    Configure AvailabilityGroupConfigureResponse
    null
    ReplicaName string
    the replica name.
    State AvailabilityGroupStateResponse
    null
    replicaId String
    ID GUID of the availability group.
    configure AvailabilityGroupConfigureResponse
    null
    replicaName String
    the replica name.
    state AvailabilityGroupStateResponse
    null
    replicaId string
    ID GUID of the availability group.
    configure AvailabilityGroupConfigureResponse
    null
    replicaName string
    the replica name.
    state AvailabilityGroupStateResponse
    null
    replica_id str
    ID GUID of the availability group.
    configure AvailabilityGroupConfigureResponse
    null
    replica_name str
    the replica name.
    state AvailabilityGroupStateResponse
    null
    replicaId String
    ID GUID of the availability group.
    configure Property Map
    null
    replicaName String
    the replica name.
    state Property Map
    null

    SqlServerAvailabilityGroupResourcePropertiesResponse

    AvailabilityGroupId string
    ID GUID of the availability group.
    CollectionTimestamp string
    Timestamp for when the data was collected from the client machine.
    InstanceName string
    the SQL Server Instance name.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    ServerName string
    the SQL server name.
    Databases Pulumi.AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourcePropertiesResponseDatabases
    A list of Availability Group Database Replicas.
    Info Pulumi.AzureNative.AzureArcData.Inputs.AvailabilityGroupInfoResponse
    Availability Group Info
    Replicas Pulumi.AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
    A list of Availability Group Replicas.
    AvailabilityGroupId string
    ID GUID of the availability group.
    CollectionTimestamp string
    Timestamp for when the data was collected from the client machine.
    InstanceName string
    the SQL Server Instance name.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    ServerName string
    the SQL server name.
    Databases SqlServerAvailabilityGroupResourcePropertiesResponseDatabases
    A list of Availability Group Database Replicas.
    Info AvailabilityGroupInfoResponse
    Availability Group Info
    Replicas SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
    A list of Availability Group Replicas.
    availabilityGroupId String
    ID GUID of the availability group.
    collectionTimestamp String
    Timestamp for when the data was collected from the client machine.
    instanceName String
    the SQL Server Instance name.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    serverName String
    the SQL server name.
    databases SqlServerAvailabilityGroupResourcePropertiesResponseDatabases
    A list of Availability Group Database Replicas.
    info AvailabilityGroupInfoResponse
    Availability Group Info
    replicas SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
    A list of Availability Group Replicas.
    availabilityGroupId string
    ID GUID of the availability group.
    collectionTimestamp string
    Timestamp for when the data was collected from the client machine.
    instanceName string
    the SQL Server Instance name.
    provisioningState string
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    serverName string
    the SQL server name.
    databases SqlServerAvailabilityGroupResourcePropertiesResponseDatabases
    A list of Availability Group Database Replicas.
    info AvailabilityGroupInfoResponse
    Availability Group Info
    replicas SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
    A list of Availability Group Replicas.
    availability_group_id str
    ID GUID of the availability group.
    collection_timestamp str
    Timestamp for when the data was collected from the client machine.
    instance_name str
    the SQL Server Instance name.
    provisioning_state str
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    server_name str
    the SQL server name.
    databases SqlServerAvailabilityGroupResourcePropertiesResponseDatabases
    A list of Availability Group Database Replicas.
    info AvailabilityGroupInfoResponse
    Availability Group Info
    replicas SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
    A list of Availability Group Replicas.
    availabilityGroupId String
    ID GUID of the availability group.
    collectionTimestamp String
    Timestamp for when the data was collected from the client machine.
    instanceName String
    the SQL Server Instance name.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server availability group resource.
    serverName String
    the SQL server name.
    databases Property Map
    A list of Availability Group Database Replicas.
    info Property Map
    Availability Group Info
    replicas Property Map
    A list of Availability Group Replicas.

    SqlServerAvailabilityGroupResourcePropertiesResponseDatabases

    NextLink string
    Link to retrieve next page of results.
    Value List<Pulumi.AzureNative.AzureArcData.Inputs.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse>
    Array of Availability Group Database Replicas.
    NextLink string
    Link to retrieve next page of results.
    Value []SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse
    Array of Availability Group Database Replicas.
    nextLink String
    Link to retrieve next page of results.
    value List<SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse>
    Array of Availability Group Database Replicas.
    nextLink string
    Link to retrieve next page of results.
    value SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse[]
    Array of Availability Group Database Replicas.
    next_link str
    Link to retrieve next page of results.
    value Sequence[SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse]
    Array of Availability Group Database Replicas.
    nextLink String
    Link to retrieve next page of results.
    value List<Property Map>
    Array of Availability Group Database Replicas.

    SqlServerAvailabilityGroupResourcePropertiesResponseReplicas

    NextLink string
    Link to retrieve next page of results.
    Value List<Pulumi.AzureNative.AzureArcData.Inputs.SqlAvailabilityGroupReplicaResourcePropertiesResponse>
    Array of Availability Group Replicas.
    NextLink string
    Link to retrieve next page of results.
    Value []SqlAvailabilityGroupReplicaResourcePropertiesResponse
    Array of Availability Group Replicas.
    nextLink String
    Link to retrieve next page of results.
    value List<SqlAvailabilityGroupReplicaResourcePropertiesResponse>
    Array of Availability Group Replicas.
    nextLink string
    Link to retrieve next page of results.
    value SqlAvailabilityGroupReplicaResourcePropertiesResponse[]
    Array of Availability Group Replicas.
    next_link str
    Link to retrieve next page of results.
    value Sequence[SqlAvailabilityGroupReplicaResourcePropertiesResponse]
    Array of Availability Group Replicas.
    nextLink String
    Link to retrieve next page of results.
    value List<Property Map>
    Array of Availability Group Replicas.

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