Resource Type: dsc_sqlagreplica

Properties

dsc_availabilitymode

Specifies the replica availability mode. When creating a replica 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 replica the default is `50`.
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_endpointhostname

Specifies the hostname or IP address of the availability group replica endpoint. When creating a group the default is the instance network name which is set in the code because the value can only be determined when connected to the _SQL Server_ instance.
dsc_endpointport

Returns the network port the endpoint is listening on.
dsc_endpointurl

Returns the URL of the availability group replica endpoint.
dsc_ensure

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

Specifies the failover mode. When creating a replica the default value is ‘’Manual’‘.
dsc_isactivenode

Returns if the current node is actively hosting the _SQL Server Database Engine_ instance.
dsc_primaryreplicainstancename

Name of the _SQL Server Database Engine_ instance where the primary replica lives.
dsc_primaryreplicaservername

Hostname of the _SQL Server_ where the primary replica is expected to be active. If the primary replica is not found here, the resource will attempt to find the host that holds the primary replica and connect to it.
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_readonlyroutingconnectionurl

Specifies the fully qualified domain name (FQDN) and port to use when routing to the replica for read only connections.
dsc_readonlyroutinglist

Specifies an ordered list of replica server names that represent the probe sequence for connection director to use when redirecting read-only connections through this availability replica. This parameter applies if the availability replica is the current primary replica of the availability group.
dsc_seedingmode

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

Hostname of the _SQL Server_ to be configured.

Parameters

dsc_availabilitygroupname (namevar)

The name of the availability group.
dsc_instancename (namevar)

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

The name of the availability group replica. For named instances this must be in the following format ‘’ServerNameInstanceName’‘.
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