Examples/Resources/SqlServerDatabaseMail/1-EnableDatabaseMail.ps1
|
<#
.EXAMPLE This example will enable Database Mail on a SQL Server instance and create a mail account with a default public profile. #> $ConfigurationData = @{ AllNodes = @( @{ NodeName = 'localhost' ServerName = $env:COMPUTERNAME InstanceName = 'DSCSQL2016' MailServerName = 'mail.company.local' AccountName = 'MyMail' ProfileName = 'MyMailProfile' EmailAddress = 'NoReply@company.local' Description = 'Default mail account and profile.' LoggingLevel = 'Normal' TcpPort = 25 <# NOTE! THIS IS NOT RECOMMENDED IN PRODUCTION. This is added so that AppVeyor automatic tests can pass, otherwise the tests will fail on passwords being in plain text and not being encrypted. Because it is not possible to have a certificate in AppVeyor to encrypt the passwords we need to add the parameter 'PSDscAllowPlainTextPassword'. NOTE! THIS IS NOT RECOMMENDED IN PRODUCTION. #> PSDscAllowPlainTextPassword = $true } ) } Configuration Example { param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.Management.Automation.PSCredential] $SqlInstallCredential ) Import-DscResource -ModuleName 'SqlServerDsc' node localhost { SqlServerConfiguration 'EnableDatabaseMailXPs' { ServerName = $Node.ServerName InstanceName = $Node.InstanceName OptionName = 'Database Mail XPs' OptionValue = 1 RestartService = $false } SqlServerDatabaseMail 'EnableDatabaseMail' { Ensure = 'Present' ServerName = $Node.ServerName InstanceName = $Node.InstanceName AccountName = $Node.AccountName ProfileName = $Node.ProfileName EmailAddress = $Node.EmailAddress ReplyToAddress = $Node.EmailAddress DisplayName = $Node.MailServerName MailServerName = $Node.MailServerName Description = $Node.Description LoggingLevel = $Node.LoggingLevel TcpPort = $Node.TcpPort PsDscRunAsCredential = $SqlInstallCredential } } } |