Resource Type: dsc_sqlag

Properties

dsc_automatedbackuppreference

Specifies the automated backup preference for the availability group. When creating a group the default is ‘’None’‘.
dsc_availabilitymode

Specifies the replica availability mode. When creating a group the default is ‘’AsynchronousCommit’‘.
dsc_backuppriority

Specifies the desired priority of the replicas in performing backups. The acceptable values for this parameter are: integers from ‘0` through `100`. Of the set of replicas which are online and available, the replica that has the highest priority performs the backup. When creating a group the default is `50`.
dsc_basicavailabilitygroup

Specifies the type of availability group is Basic. This is only available is _SQL Server 2016_ and later and is ignored when applied to previous versions.
dsc_connectionmodeinprimaryrole

Specifies how the availability replica handles connections when in the primary role.
dsc_connectionmodeinsecondaryrole

Specifies how the availability replica handles connections when in the secondary role.
dsc_databasehealthtrigger

Specifies if the option _Database Level Health Detection_ is enabled. This is only available is _SQL Server 2016_ and later and is ignored when applied to previous versions.
dsc_dtcsupportenabled

Specifies if the option _Database DTC Support_ is enabled. This is only available is _SQL Server 2016_ and later and is ignored when applied to previous versions. This can not be altered once the availability group is created and is ignored if it is the case.
dsc_endpointhostname

Specifies the hostname or IP address of the availability group replica endpoint. When creating a group the default is the instance network name.
dsc_endpointport

Returns the port the database mirroring endpoint is listening on.
dsc_endpointurl

Returns the URL of the availability group replica endpoint.
dsc_ensure

Specifies if the availability group should be present or absent. Default value is ‘’Present’‘.
dsc_failovermode

Specifies the failover mode. When creating a group the default is ‘’Manual’‘.
dsc_failureconditionlevel

Specifies the automatic failover behavior of the availability group.
dsc_healthchecktimeout

Specifies the length of time, in milliseconds, after which _AlwaysOn Availability Groups_ declare an unresponsive server to be unhealthy. When creating a group the default is ‘30000`.
dsc_isactivenode

Returns if the current node is actively hosting the _SQL Server_ instance.
dsc_processonlyonactivenode

Specifies that the resource will only determine if a change is needed if the target node is the active host of the _SQL Server_ instance.
dsc_seedingmode

Specifies the seeding mode. When creating a group the default is ‘’Manual`‘.
dsc_servername

Hostname of the SQL Server to be configured.
dsc_version

Returns the major version of the _SQL Server_ instance.

Parameters

dsc_instancename (namevar)

Name of the SQL instance to be configured.
dsc_name (namevar)

Specifies the name of the availability group.
dsc_psdscrunascredential
dsc_timeout

The maximum time in seconds to wait for the DSC resource to complete.
name (namevar)

Description of the purpose for this resource declaration.
validation_mode (defaults to: property)

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Overview