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

azure-native-v2.azurearcdata.SqlServerAvailabilityGroup

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

Arc Sql Server Availability Group Azure REST API version: 2024-01-01.

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

Example Usage

Create a Arc Sql Server availability group.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlServerAvailabilityGroup = new AzureNative.AzureArcData.SqlServerAvailabilityGroup("sqlServerAvailabilityGroup", new()
    {
        AvailabilityGroupName = "testAG",
        Location = "southeastasia",
        Properties = new AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourcePropertiesArgs
        {
            Databases = new AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourcePropertiesDatabasesArgs
            {
                Value = new[]
                {
                    new AzureNative.AzureArcData.Inputs.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs
                    {
                        DatabaseName = "db1",
                    },
                    new AzureNative.AzureArcData.Inputs.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs
                    {
                        DatabaseName = "db2",
                    },
                },
            },
            Info = new AzureNative.AzureArcData.Inputs.AvailabilityGroupInfoArgs
            {
                BasicFeatures = false,
                DbFailover = true,
                DtcSupport = false,
                FailureConditionLevel = 3,
                HealthCheckTimeout = 30000,
                IsContained = false,
                IsDistributed = false,
                RequiredSynchronizedSecondariesToCommit = 0,
            },
            Replicas = new AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourcePropertiesReplicasArgs
            {
                Value = new[]
                {
                    new AzureNative.AzureArcData.Inputs.SqlAvailabilityGroupReplicaResourcePropertiesArgs
                    {
                        Configure = new AzureNative.AzureArcData.Inputs.AvailabilityGroupConfigureArgs
                        {
                            BackupPriority = 50,
                            EndpointUrl = "TCP://mytest60-0.mytest60-svc:5022",
                            SessionTimeout = 10,
                        },
                        ReplicaName = "testSqlServer\\INST1",
                    },
                },
            },
        },
        ResourceGroupName = "testrg",
        SqlServerInstanceName = "testSqlServer_INST1",
        Tags = 
        {
            { "mytag", "myval" },
        },
    });

});
Copy
package main

import (
	azurearcdata "github.com/pulumi/pulumi-azure-native-sdk/azurearcdata/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurearcdata.NewSqlServerAvailabilityGroup(ctx, "sqlServerAvailabilityGroup", &azurearcdata.SqlServerAvailabilityGroupArgs{
			AvailabilityGroupName: pulumi.String("testAG"),
			Location:              pulumi.String("southeastasia"),
			Properties: &azurearcdata.SqlServerAvailabilityGroupResourcePropertiesArgs{
				Databases: &azurearcdata.SqlServerAvailabilityGroupResourcePropertiesDatabasesArgs{
					Value: azurearcdata.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArray{
						&azurearcdata.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs{
							DatabaseName: pulumi.String("db1"),
						},
						&azurearcdata.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs{
							DatabaseName: pulumi.String("db2"),
						},
					},
				},
				Info: &azurearcdata.AvailabilityGroupInfoArgs{
					BasicFeatures:                           pulumi.Bool(false),
					DbFailover:                              pulumi.Bool(true),
					DtcSupport:                              pulumi.Bool(false),
					FailureConditionLevel:                   pulumi.Int(3),
					HealthCheckTimeout:                      pulumi.Int(30000),
					IsContained:                             pulumi.Bool(false),
					IsDistributed:                           pulumi.Bool(false),
					RequiredSynchronizedSecondariesToCommit: pulumi.Int(0),
				},
				Replicas: &azurearcdata.SqlServerAvailabilityGroupResourcePropertiesReplicasArgs{
					Value: azurearcdata.SqlAvailabilityGroupReplicaResourcePropertiesArray{
						&azurearcdata.SqlAvailabilityGroupReplicaResourcePropertiesArgs{
							Configure: &azurearcdata.AvailabilityGroupConfigureArgs{
								BackupPriority: pulumi.Int(50),
								EndpointUrl:    pulumi.String("TCP://mytest60-0.mytest60-svc:5022"),
								SessionTimeout: pulumi.Int(10),
							},
							ReplicaName: pulumi.String("testSqlServer\\INST1"),
						},
					},
				},
			},
			ResourceGroupName:     pulumi.String("testrg"),
			SqlServerInstanceName: pulumi.String("testSqlServer_INST1"),
			Tags: pulumi.StringMap{
				"mytag": pulumi.String("myval"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurearcdata.SqlServerAvailabilityGroup;
import com.pulumi.azurenative.azurearcdata.SqlServerAvailabilityGroupArgs;
import com.pulumi.azurenative.azurearcdata.inputs.SqlServerAvailabilityGroupResourcePropertiesArgs;
import com.pulumi.azurenative.azurearcdata.inputs.SqlServerAvailabilityGroupResourcePropertiesDatabasesArgs;
import com.pulumi.azurenative.azurearcdata.inputs.AvailabilityGroupInfoArgs;
import com.pulumi.azurenative.azurearcdata.inputs.SqlServerAvailabilityGroupResourcePropertiesReplicasArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sqlServerAvailabilityGroup = new SqlServerAvailabilityGroup("sqlServerAvailabilityGroup", SqlServerAvailabilityGroupArgs.builder()
            .availabilityGroupName("testAG")
            .location("southeastasia")
            .properties(SqlServerAvailabilityGroupResourcePropertiesArgs.builder()
                .databases(SqlServerAvailabilityGroupResourcePropertiesDatabasesArgs.builder()
                    .value(                    
                        SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs.builder()
                            .databaseName("db1")
                            .build(),
                        SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs.builder()
                            .databaseName("db2")
                            .build())
                    .build())
                .info(AvailabilityGroupInfoArgs.builder()
                    .basicFeatures(false)
                    .dbFailover(true)
                    .dtcSupport(false)
                    .failureConditionLevel(3)
                    .healthCheckTimeout(30000)
                    .isContained(false)
                    .isDistributed(false)
                    .requiredSynchronizedSecondariesToCommit(0)
                    .build())
                .replicas(SqlServerAvailabilityGroupResourcePropertiesReplicasArgs.builder()
                    .value(SqlAvailabilityGroupReplicaResourcePropertiesArgs.builder()
                        .configure(AvailabilityGroupConfigureArgs.builder()
                            .backupPriority(50)
                            .endpointUrl("TCP://mytest60-0.mytest60-svc:5022")
                            .sessionTimeout(10)
                            .build())
                        .replicaName("testSqlServer\\INST1")
                        .build())
                    .build())
                .build())
            .resourceGroupName("testrg")
            .sqlServerInstanceName("testSqlServer_INST1")
            .tags(Map.of("mytag", "myval"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlServerAvailabilityGroup = new azure_native.azurearcdata.SqlServerAvailabilityGroup("sqlServerAvailabilityGroup", {
    availabilityGroupName: "testAG",
    location: "southeastasia",
    properties: {
        databases: {
            value: [
                {
                    databaseName: "db1",
                },
                {
                    databaseName: "db2",
                },
            ],
        },
        info: {
            basicFeatures: false,
            dbFailover: true,
            dtcSupport: false,
            failureConditionLevel: 3,
            healthCheckTimeout: 30000,
            isContained: false,
            isDistributed: false,
            requiredSynchronizedSecondariesToCommit: 0,
        },
        replicas: {
            value: [{
                configure: {
                    backupPriority: 50,
                    endpointUrl: "TCP://mytest60-0.mytest60-svc:5022",
                    sessionTimeout: 10,
                },
                replicaName: "testSqlServer\\INST1",
            }],
        },
    },
    resourceGroupName: "testrg",
    sqlServerInstanceName: "testSqlServer_INST1",
    tags: {
        mytag: "myval",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_server_availability_group = azure_native.azurearcdata.SqlServerAvailabilityGroup("sqlServerAvailabilityGroup",
    availability_group_name="testAG",
    location="southeastasia",
    properties={
        "databases": {
            "value": [
                {
                    "database_name": "db1",
                },
                {
                    "database_name": "db2",
                },
            ],
        },
        "info": {
            "basic_features": False,
            "db_failover": True,
            "dtc_support": False,
            "failure_condition_level": 3,
            "health_check_timeout": 30000,
            "is_contained": False,
            "is_distributed": False,
            "required_synchronized_secondaries_to_commit": 0,
        },
        "replicas": {
            "value": [{
                "configure": {
                    "backup_priority": 50,
                    "endpoint_url": "TCP://mytest60-0.mytest60-svc:5022",
                    "session_timeout": 10,
                },
                "replica_name": "testSqlServer\\INST1",
            }],
        },
    },
    resource_group_name="testrg",
    sql_server_instance_name="testSqlServer_INST1",
    tags={
        "mytag": "myval",
    })
Copy
resources:
  sqlServerAvailabilityGroup:
    type: azure-native:azurearcdata:SqlServerAvailabilityGroup
    properties:
      availabilityGroupName: testAG
      location: southeastasia
      properties:
        databases:
          value:
            - databaseName: db1
            - databaseName: db2
        info:
          basicFeatures: false
          dbFailover: true
          dtcSupport: false
          failureConditionLevel: 3
          healthCheckTimeout: 30000
          isContained: false
          isDistributed: false
          requiredSynchronizedSecondariesToCommit: 0
        replicas:
          value:
            - configure:
                backupPriority: 50
                endpointUrl: TCP://mytest60-0.mytest60-svc:5022
                sessionTimeout: 10
              replicaName: testSqlServer\INST1
      resourceGroupName: testrg
      sqlServerInstanceName: testSqlServer_INST1
      tags:
        mytag: myval
Copy

Create SqlServerAvailabilityGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SqlServerAvailabilityGroup(name: string, args: SqlServerAvailabilityGroupArgs, opts?: CustomResourceOptions);
@overload
def SqlServerAvailabilityGroup(resource_name: str,
                               args: SqlServerAvailabilityGroupArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def SqlServerAvailabilityGroup(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               properties: Optional[SqlServerAvailabilityGroupResourcePropertiesArgs] = None,
                               resource_group_name: Optional[str] = None,
                               sql_server_instance_name: Optional[str] = None,
                               availability_group_name: Optional[str] = None,
                               location: Optional[str] = None,
                               tags: Optional[Mapping[str, str]] = None)
func NewSqlServerAvailabilityGroup(ctx *Context, name string, args SqlServerAvailabilityGroupArgs, opts ...ResourceOption) (*SqlServerAvailabilityGroup, error)
public SqlServerAvailabilityGroup(string name, SqlServerAvailabilityGroupArgs args, CustomResourceOptions? opts = null)
public SqlServerAvailabilityGroup(String name, SqlServerAvailabilityGroupArgs args)
public SqlServerAvailabilityGroup(String name, SqlServerAvailabilityGroupArgs args, CustomResourceOptions options)

type: azure-native:azurearcdata:SqlServerAvailabilityGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SqlServerAvailabilityGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SqlServerAvailabilityGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SqlServerAvailabilityGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SqlServerAvailabilityGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SqlServerAvailabilityGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sqlServerAvailabilityGroupResource = new AzureNative.Azurearcdata.SqlServerAvailabilityGroup("sqlServerAvailabilityGroupResource", new()
{
    Properties = 
    {
        { "databases", 
        {
            { "value", new[]
            {
                
                {
                    { "databaseName", "string" },
                },
            } },
        } },
        { "info", 
        {
            { "basicFeatures", false },
            { "dbFailover", false },
            { "dtcSupport", false },
            { "failureConditionLevel", 0 },
            { "healthCheckTimeout", 0 },
            { "isContained", false },
            { "isDistributed", false },
            { "requiredSynchronizedSecondariesToCommit", 0 },
        } },
        { "replicas", 
        {
            { "value", new[]
            {
                
                {
                    { "configure", 
                    {
                        { "backupPriority", 0 },
                        { "endpointUrl", "string" },
                        { "readOnlyRoutingUrl", "string" },
                        { "readWriteRoutingUrl", "string" },
                        { "sessionTimeout", 0 },
                    } },
                    { "replicaName", "string" },
                },
            } },
        } },
    },
    ResourceGroupName = "string",
    SqlServerInstanceName = "string",
    AvailabilityGroupName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := azurearcdata.NewSqlServerAvailabilityGroup(ctx, "sqlServerAvailabilityGroupResource", &azurearcdata.SqlServerAvailabilityGroupArgs{
	Properties: map[string]interface{}{
		"databases": map[string]interface{}{
			"value": []map[string]interface{}{
				map[string]interface{}{
					"databaseName": "string",
				},
			},
		},
		"info": map[string]interface{}{
			"basicFeatures":         false,
			"dbFailover":            false,
			"dtcSupport":            false,
			"failureConditionLevel": 0,
			"healthCheckTimeout":    0,
			"isContained":           false,
			"isDistributed":         false,
			"requiredSynchronizedSecondariesToCommit": 0,
		},
		"replicas": map[string]interface{}{
			"value": []map[string]interface{}{
				map[string]interface{}{
					"configure": map[string]interface{}{
						"backupPriority":      0,
						"endpointUrl":         "string",
						"readOnlyRoutingUrl":  "string",
						"readWriteRoutingUrl": "string",
						"sessionTimeout":      0,
					},
					"replicaName": "string",
				},
			},
		},
	},
	ResourceGroupName:     "string",
	SqlServerInstanceName: "string",
	AvailabilityGroupName: "string",
	Location:              "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var sqlServerAvailabilityGroupResource = new SqlServerAvailabilityGroup("sqlServerAvailabilityGroupResource", SqlServerAvailabilityGroupArgs.builder()
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .sqlServerInstanceName("string")
    .availabilityGroupName("string")
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
sql_server_availability_group_resource = azure_native.azurearcdata.SqlServerAvailabilityGroup("sqlServerAvailabilityGroupResource",
    properties={
        databases: {
            value: [{
                databaseName: string,
            }],
        },
        info: {
            basicFeatures: False,
            dbFailover: False,
            dtcSupport: False,
            failureConditionLevel: 0,
            healthCheckTimeout: 0,
            isContained: False,
            isDistributed: False,
            requiredSynchronizedSecondariesToCommit: 0,
        },
        replicas: {
            value: [{
                configure: {
                    backupPriority: 0,
                    endpointUrl: string,
                    readOnlyRoutingUrl: string,
                    readWriteRoutingUrl: string,
                    sessionTimeout: 0,
                },
                replicaName: string,
            }],
        },
    },
    resource_group_name=string,
    sql_server_instance_name=string,
    availability_group_name=string,
    location=string,
    tags={
        string: string,
    })
Copy
const sqlServerAvailabilityGroupResource = new azure_native.azurearcdata.SqlServerAvailabilityGroup("sqlServerAvailabilityGroupResource", {
    properties: {
        databases: {
            value: [{
                databaseName: "string",
            }],
        },
        info: {
            basicFeatures: false,
            dbFailover: false,
            dtcSupport: false,
            failureConditionLevel: 0,
            healthCheckTimeout: 0,
            isContained: false,
            isDistributed: false,
            requiredSynchronizedSecondariesToCommit: 0,
        },
        replicas: {
            value: [{
                configure: {
                    backupPriority: 0,
                    endpointUrl: "string",
                    readOnlyRoutingUrl: "string",
                    readWriteRoutingUrl: "string",
                    sessionTimeout: 0,
                },
                replicaName: "string",
            }],
        },
    },
    resourceGroupName: "string",
    sqlServerInstanceName: "string",
    availabilityGroupName: "string",
    location: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:azurearcdata:SqlServerAvailabilityGroup
properties:
    availabilityGroupName: string
    location: string
    properties:
        databases:
            value:
                - databaseName: string
        info:
            basicFeatures: false
            dbFailover: false
            dtcSupport: false
            failureConditionLevel: 0
            healthCheckTimeout: 0
            isContained: false
            isDistributed: false
            requiredSynchronizedSecondariesToCommit: 0
        replicas:
            value:
                - configure:
                    backupPriority: 0
                    endpointUrl: string
                    readOnlyRoutingUrl: string
                    readWriteRoutingUrl: string
                    sessionTimeout: 0
                  replicaName: string
    resourceGroupName: string
    sqlServerInstanceName: string
    tags:
        string: string
Copy

SqlServerAvailabilityGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SqlServerAvailabilityGroup resource accepts the following input properties:

Properties This property is required. Pulumi.AzureNative.AzureArcData.Inputs.SqlServerAvailabilityGroupResourceProperties
Properties of Arc Sql Server availability group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
SqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
AvailabilityGroupName Changes to this property will trigger replacement. string
Name of SQL Availability Group
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
Properties This property is required. SqlServerAvailabilityGroupResourcePropertiesArgs
Properties of Arc Sql Server availability group
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
SqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
AvailabilityGroupName Changes to this property will trigger replacement. string
Name of SQL Availability Group
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
properties This property is required. SqlServerAvailabilityGroupResourceProperties
Properties of Arc Sql Server availability group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Server Instance
availabilityGroupName Changes to this property will trigger replacement. String
Name of SQL Availability Group
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
properties This property is required. SqlServerAvailabilityGroupResourceProperties
Properties of Arc Sql Server availability group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
availabilityGroupName Changes to this property will trigger replacement. string
Name of SQL Availability Group
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
properties This property is required. SqlServerAvailabilityGroupResourcePropertiesArgs
Properties of Arc Sql Server availability group
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure resource group
sql_server_instance_name
This property is required.
Changes to this property will trigger replacement.
str
Name of SQL Server Instance
availability_group_name Changes to this property will trigger replacement. str
Name of SQL Availability Group
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
properties This property is required. Property Map
Properties of Arc Sql Server availability group
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Server Instance
availabilityGroupName Changes to this property will trigger replacement. String
Name of SQL Availability Group
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlServerAvailabilityGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
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
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
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
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
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
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
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
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
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
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
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

AvailabilityGroupConfigure
, AvailabilityGroupConfigureArgs

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.
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.
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.
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.
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.
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.

AvailabilityGroupConfigureResponse
, AvailabilityGroupConfigureResponseArgs

AvailabilityModeDescription This property is required. string
The Availability Synchronization mode of the availability group replica.
FailoverModeDescription This property is required. string
The failover mode of the availability group replica.
PrimaryRoleAllowConnectionsDescription This property is required. string
Whether the availability allows all connections or only read-write connections.
ReplicaCreateDate This property is required. string
Date that the replica was created.
ReplicaModifyDate This property is required. string
Date that the replica was modified.
SecondaryRoleAllowConnectionsDescription This property is required. string
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
SeedingModeDescription This property is required. 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 This property is required. string
The Availability Synchronization mode of the availability group replica.
FailoverModeDescription This property is required. string
The failover mode of the availability group replica.
PrimaryRoleAllowConnectionsDescription This property is required. string
Whether the availability allows all connections or only read-write connections.
ReplicaCreateDate This property is required. string
Date that the replica was created.
ReplicaModifyDate This property is required. string
Date that the replica was modified.
SecondaryRoleAllowConnectionsDescription This property is required. string
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
SeedingModeDescription This property is required. 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 This property is required. String
The Availability Synchronization mode of the availability group replica.
failoverModeDescription This property is required. String
The failover mode of the availability group replica.
primaryRoleAllowConnectionsDescription This property is required. String
Whether the availability allows all connections or only read-write connections.
replicaCreateDate This property is required. String
Date that the replica was created.
replicaModifyDate This property is required. String
Date that the replica was modified.
secondaryRoleAllowConnectionsDescription This property is required. String
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
seedingModeDescription This property is required. 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 This property is required. string
The Availability Synchronization mode of the availability group replica.
failoverModeDescription This property is required. string
The failover mode of the availability group replica.
primaryRoleAllowConnectionsDescription This property is required. string
Whether the availability allows all connections or only read-write connections.
replicaCreateDate This property is required. string
Date that the replica was created.
replicaModifyDate This property is required. string
Date that the replica was modified.
secondaryRoleAllowConnectionsDescription This property is required. string
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
seedingModeDescription This property is required. 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 This property is required. str
The Availability Synchronization mode of the availability group replica.
failover_mode_description This property is required. str
The failover mode of the availability group replica.
primary_role_allow_connections_description This property is required. str
Whether the availability allows all connections or only read-write connections.
replica_create_date This property is required. str
Date that the replica was created.
replica_modify_date This property is required. str
Date that the replica was modified.
secondary_role_allow_connections_description This property is required. str
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
seeding_mode_description This property is required. 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 This property is required. String
The Availability Synchronization mode of the availability group replica.
failoverModeDescription This property is required. String
The failover mode of the availability group replica.
primaryRoleAllowConnectionsDescription This property is required. String
Whether the availability allows all connections or only read-write connections.
replicaCreateDate This property is required. String
Date that the replica was created.
replicaModifyDate This property is required. String
Date that the replica was modified.
secondaryRoleAllowConnectionsDescription This property is required. String
Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.
seedingModeDescription This property is required. 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.

AvailabilityGroupInfo
, AvailabilityGroupInfoArgs

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.
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.
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.
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.
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.
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.

AvailabilityGroupInfoResponse
, AvailabilityGroupInfoResponseArgs

AutomatedBackupPreferenceDescription This property is required. string
Preferred location for performing backups on the availability databases in this availability group.
ClusterTypeDescription This property is required. string
SQL Server availability group cluster type description
PrimaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of the primary replica.
PrimaryReplica This property is required. string
Name of the server instance that is hosting the current primary replica.
ReplicationPartnerType This property is required. string
SecondaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of a secondary replica.
SynchronizationHealthDescription This property is required. string
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
Version This property is required. 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 This property is required. string
Preferred location for performing backups on the availability databases in this availability group.
ClusterTypeDescription This property is required. string
SQL Server availability group cluster type description
PrimaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of the primary replica.
PrimaryReplica This property is required. string
Name of the server instance that is hosting the current primary replica.
ReplicationPartnerType This property is required. string
SecondaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of a secondary replica.
SynchronizationHealthDescription This property is required. string
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
Version This property is required. 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 This property is required. String
Preferred location for performing backups on the availability databases in this availability group.
clusterTypeDescription This property is required. String
SQL Server availability group cluster type description
primaryRecoveryHealthDescription This property is required. String
Indicates the recovery health of the primary replica.
primaryReplica This property is required. String
Name of the server instance that is hosting the current primary replica.
replicationPartnerType This property is required. String
secondaryRecoveryHealthDescription This property is required. String
Indicates the recovery health of a secondary replica.
synchronizationHealthDescription This property is required. String
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
version This property is required. 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 This property is required. string
Preferred location for performing backups on the availability databases in this availability group.
clusterTypeDescription This property is required. string
SQL Server availability group cluster type description
primaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of the primary replica.
primaryReplica This property is required. string
Name of the server instance that is hosting the current primary replica.
replicationPartnerType This property is required. string
secondaryRecoveryHealthDescription This property is required. string
Indicates the recovery health of a secondary replica.
synchronizationHealthDescription This property is required. string
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
version This property is required. 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 This property is required. str
Preferred location for performing backups on the availability databases in this availability group.
cluster_type_description This property is required. str
SQL Server availability group cluster type description
primary_recovery_health_description This property is required. str
Indicates the recovery health of the primary replica.
primary_replica This property is required. str
Name of the server instance that is hosting the current primary replica.
replication_partner_type This property is required. str
secondary_recovery_health_description This property is required. str
Indicates the recovery health of a secondary replica.
synchronization_health_description This property is required. str
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
version This property is required. 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 This property is required. String
Preferred location for performing backups on the availability databases in this availability group.
clusterTypeDescription This property is required. String
SQL Server availability group cluster type description
primaryRecoveryHealthDescription This property is required. String
Indicates the recovery health of the primary replica.
primaryReplica This property is required. String
Name of the server instance that is hosting the current primary replica.
replicationPartnerType This property is required. String
secondaryRecoveryHealthDescription This property is required. String
Indicates the recovery health of a secondary replica.
synchronizationHealthDescription This property is required. String
Reflects a roll-up of the synchronization health of all availability replicas in the availability group.
version This property is required. 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
, AvailabilityGroupStateResponseArgs

AvailabilityGroupReplicaRole This property is required. string
Current Always On availability groups role of the availability group replica.
ConnectedStateDescription This property is required. string
Whether a secondary replica is currently connected to the primary replica.
LastConnectErrorDescription This property is required. string
Text description of the last connection error of the availability group replica.
LastConnectErrorTimestamp This property is required. string
Date and time timestamp indicating when the last connect error occurred.
OperationalStateDescription This property is required. string
Current operational state of the availability group replica
RecoveryHealthDescription This property is required. string
Recovery health of the availability group replica.
SynchronizationHealthDescription This property is required. 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 This property is required. string
Current Always On availability groups role of the availability group replica.
ConnectedStateDescription This property is required. string
Whether a secondary replica is currently connected to the primary replica.
LastConnectErrorDescription This property is required. string
Text description of the last connection error of the availability group replica.
LastConnectErrorTimestamp This property is required. string
Date and time timestamp indicating when the last connect error occurred.
OperationalStateDescription This property is required. string
Current operational state of the availability group replica
RecoveryHealthDescription This property is required. string
Recovery health of the availability group replica.
SynchronizationHealthDescription This property is required. 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 This property is required. String
Current Always On availability groups role of the availability group replica.
connectedStateDescription This property is required. String
Whether a secondary replica is currently connected to the primary replica.
lastConnectErrorDescription This property is required. String
Text description of the last connection error of the availability group replica.
lastConnectErrorTimestamp This property is required. String
Date and time timestamp indicating when the last connect error occurred.
operationalStateDescription This property is required. String
Current operational state of the availability group replica
recoveryHealthDescription This property is required. String
Recovery health of the availability group replica.
synchronizationHealthDescription This property is required. 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 This property is required. string
Current Always On availability groups role of the availability group replica.
connectedStateDescription This property is required. string
Whether a secondary replica is currently connected to the primary replica.
lastConnectErrorDescription This property is required. string
Text description of the last connection error of the availability group replica.
lastConnectErrorTimestamp This property is required. string
Date and time timestamp indicating when the last connect error occurred.
operationalStateDescription This property is required. string
Current operational state of the availability group replica
recoveryHealthDescription This property is required. string
Recovery health of the availability group replica.
synchronizationHealthDescription This property is required. 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 This property is required. str
Current Always On availability groups role of the availability group replica.
connected_state_description This property is required. str
Whether a secondary replica is currently connected to the primary replica.
last_connect_error_description This property is required. str
Text description of the last connection error of the availability group replica.
last_connect_error_timestamp This property is required. str
Date and time timestamp indicating when the last connect error occurred.
operational_state_description This property is required. str
Current operational state of the availability group replica
recovery_health_description This property is required. str
Recovery health of the availability group replica.
synchronization_health_description This property is required. 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 This property is required. String
Current Always On availability groups role of the availability group replica.
connectedStateDescription This property is required. String
Whether a secondary replica is currently connected to the primary replica.
lastConnectErrorDescription This property is required. String
Text description of the last connection error of the availability group replica.
lastConnectErrorTimestamp This property is required. String
Date and time timestamp indicating when the last connect error occurred.
operationalStateDescription This property is required. String
Current operational state of the availability group replica
recoveryHealthDescription This property is required. String
Recovery health of the availability group replica.
synchronizationHealthDescription This property is required. 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.

SqlAvailabilityGroupDatabaseReplicaResourceProperties
, SqlAvailabilityGroupDatabaseReplicaResourcePropertiesArgs

DatabaseName string
the database name.
DatabaseName string
the database name.
databaseName String
the database name.
databaseName string
the database name.
database_name str
the database name.
databaseName String
the database name.

SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse
, SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponseArgs

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

SqlAvailabilityGroupReplicaResourceProperties
, SqlAvailabilityGroupReplicaResourcePropertiesArgs

configure Property Map
null
replicaName String
the replica name.

SqlAvailabilityGroupReplicaResourcePropertiesResponse
, SqlAvailabilityGroupReplicaResourcePropertiesResponseArgs

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

SqlServerAvailabilityGroupResourceProperties
, SqlServerAvailabilityGroupResourcePropertiesArgs

Databases SqlServerAvailabilityGroupResourcePropertiesDatabases
A list of Availability Group Database Replicas.
Info AvailabilityGroupInfo
Availability Group Info
Replicas SqlServerAvailabilityGroupResourcePropertiesReplicas
A list of Availability Group Replicas.
databases SqlServerAvailabilityGroupResourcePropertiesDatabases
A list of Availability Group Database Replicas.
info AvailabilityGroupInfo
Availability Group Info
replicas SqlServerAvailabilityGroupResourcePropertiesReplicas
A list of Availability Group Replicas.
databases SqlServerAvailabilityGroupResourcePropertiesDatabases
A list of Availability Group Database Replicas.
info AvailabilityGroupInfo
Availability Group Info
replicas SqlServerAvailabilityGroupResourcePropertiesReplicas
A list of Availability Group Replicas.
databases SqlServerAvailabilityGroupResourcePropertiesDatabases
A list of Availability Group Database Replicas.
info AvailabilityGroupInfo
Availability Group Info
replicas SqlServerAvailabilityGroupResourcePropertiesReplicas
A list of Availability Group Replicas.
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.

SqlServerAvailabilityGroupResourcePropertiesDatabases
, SqlServerAvailabilityGroupResourcePropertiesDatabasesArgs

Value []SqlAvailabilityGroupDatabaseReplicaResourceProperties
Array of Availability Group Database Replicas.
value List<SqlAvailabilityGroupDatabaseReplicaResourceProperties>
Array of Availability Group Database Replicas.
value SqlAvailabilityGroupDatabaseReplicaResourceProperties[]
Array of Availability Group Database Replicas.
value Sequence[SqlAvailabilityGroupDatabaseReplicaResourceProperties]
Array of Availability Group Database Replicas.
value List<Property Map>
Array of Availability Group Database Replicas.

SqlServerAvailabilityGroupResourcePropertiesReplicas
, SqlServerAvailabilityGroupResourcePropertiesReplicasArgs

Value []SqlAvailabilityGroupReplicaResourceProperties
Array of Availability Group Replicas.
value List<SqlAvailabilityGroupReplicaResourceProperties>
Array of Availability Group Replicas.
value SqlAvailabilityGroupReplicaResourceProperties[]
Array of Availability Group Replicas.
value List<Property Map>
Array of Availability Group Replicas.

SqlServerAvailabilityGroupResourcePropertiesResponse
, SqlServerAvailabilityGroupResourcePropertiesResponseArgs

AvailabilityGroupId This property is required. string
ID GUID of the availability group.
CollectionTimestamp This property is required. string
Timestamp for when the data was collected from the client machine.
InstanceName This property is required. string
the SQL Server Instance name.
ProvisioningState This property is required. string
The provisioning state of the Arc-enabled SQL Server availability group resource.
ServerName This property is required. 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 This property is required. string
ID GUID of the availability group.
CollectionTimestamp This property is required. string
Timestamp for when the data was collected from the client machine.
InstanceName This property is required. string
the SQL Server Instance name.
ProvisioningState This property is required. string
The provisioning state of the Arc-enabled SQL Server availability group resource.
ServerName This property is required. 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 This property is required. String
ID GUID of the availability group.
collectionTimestamp This property is required. String
Timestamp for when the data was collected from the client machine.
instanceName This property is required. String
the SQL Server Instance name.
provisioningState This property is required. String
The provisioning state of the Arc-enabled SQL Server availability group resource.
serverName This property is required. 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 This property is required. string
ID GUID of the availability group.
collectionTimestamp This property is required. string
Timestamp for when the data was collected from the client machine.
instanceName This property is required. string
the SQL Server Instance name.
provisioningState This property is required. string
The provisioning state of the Arc-enabled SQL Server availability group resource.
serverName This property is required. 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 This property is required. str
ID GUID of the availability group.
collection_timestamp This property is required. str
Timestamp for when the data was collected from the client machine.
instance_name This property is required. str
the SQL Server Instance name.
provisioning_state This property is required. str
The provisioning state of the Arc-enabled SQL Server availability group resource.
server_name This property is required. 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 This property is required. String
ID GUID of the availability group.
collectionTimestamp This property is required. String
Timestamp for when the data was collected from the client machine.
instanceName This property is required. String
the SQL Server Instance name.
provisioningState This property is required. String
The provisioning state of the Arc-enabled SQL Server availability group resource.
serverName This property is required. 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
, SqlServerAvailabilityGroupResourcePropertiesResponseDatabasesArgs

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

SqlServerAvailabilityGroupResourcePropertiesResponseReplicas
, SqlServerAvailabilityGroupResourcePropertiesResponseReplicasArgs

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

SystemDataResponse
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:azurearcdata:SqlServerAvailabilityGroup testAG /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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