Resource Type: dsc_sqldatabasemail

Properties

dsc_description

The description for the _Database Mail_ profile and account.
dsc_displayname

The display name of the originating email address. Default value is the same value assigned to the parameter EmailAddress.
dsc_emailaddress

The e-mail address from which mail will originate.
dsc_ensure

Specifies the desired state of the _Database Mail_ account. When set to ‘’Present’‘ the _Database Mail_ account will be created. When set to `’Absent’‘ the _Database Mail_ account will be removed. Default value is `’Present’‘.
dsc_logginglevel

The logging level that the _Database Mail_ will use. If not specified the default logging level is ‘’Extended’‘.
dsc_mailservername

The fully qualified domain name (FQDN) of the mail server name to which e-mail are sent.
dsc_profilename

The name of the _Database Mail_ profile.
dsc_replytoaddress

The e-mail address to which the receiver of e-mails will reply to. Default value is the same e-mail address assigned to parameter EmailAddress.
dsc_servername

The hostname of the _SQL Server_ to be configured. Default value is the current computer name.
dsc_tcpport

The TCP port used for communication. Default value is port ‘25`.
dsc_usedefaultcredentials

Specifies if the DatabaseEngine credentials are used for SMTP server authentication.

Parameters

dsc_accountname (namevar)

The name of the _Database Mail_ account.
dsc_instancename (namevar)

The name of the _SQL Server_ instance to be configured.
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