SqlServerDsc

17.0.1-preview0003

DSCResources/DSC_SqlDatabaseMail/DSC_SqlDatabaseMail.schema.mof

                                [ClassVersion("1.0.0.0"), FriendlyName("SqlDatabaseMail")]

class DSC_SqlDatabaseMail : OMI_BaseResource

{

    [Key, Description("The name of the _Database Mail_ account.")] String AccountName;

    [Key, Description("The name of the _SQL Server_ instance to be configured.")] String InstanceName;

    [Required, Description("The e-mail address from which mail will originate.")] String EmailAddress;

    [Required, Description("The fully qualified domain name (FQDN) of the mail server name to which e-mail are sent.")] String MailServerName;

    [Required, Description("The name of the _Database Mail_ profile.")] String ProfileName;

    [Write, Description("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'`."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;

    [Write, Description("The hostname of the _SQL Server_ to be configured. Default value is the current computer name.")] String ServerName;

    [Write, Description("The display name of the originating email address. Default value is the same value assigned to the parameter **EmailAddress**.")] String DisplayName;

    [Write, Description("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**.")] String ReplyToAddress;

    [Write, Description("The description for the _Database Mail_ profile and account.")] String Description;

    [Write, Description("The logging level that the _Database Mail_ will use. If not specified the default logging level is `'Extended'`."), ValueMap{"Normal","Extended","Verbose"}, Values{"Normal","Extended","Verbose"}] String LoggingLevel;

    [Write, Description("The TCP port used for communication. Default value is port `25`.")] UInt16 TcpPort;

    [Write, Description("Specifies if the DatabaseEngine credentials are used for SMTP server authentication.")] Boolean UseDefaultCredentials;

};