SqlServerDsc

14.0.0-preview0024

DSCResources/DSC_SqlAlias/DSC_SqlAlias.schema.mof

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

class DSC_SqlAlias : OMI_BaseResource

{

    [Key, Description("The name of Alias (e.g. svr01\\inst01).")] String Name;

    [Write, Description("Protocol to use when connecting. Valid values are 'TCP' or 'NP' (Named Pipes). Default value is 'TCP'."), ValueMap{"TCP","NP"}, Values{"TCP","NP"}] String Protocol;

    [Write, Description("The SQL Server you are aliasing (the NetBIOS name or FQDN).")] String ServerName;

    [Write, Description("The TCP port SQL is listening on. Only used when protocol is set to 'TCP'. Default value is port 1433.")] UInt16 TcpPort;

    [Write, Description("The UseDynamicTcpPort specify that the Net-Library will determine the port dynamically. The port specified in Port number will not be used. Default value is '$false'.")] Boolean UseDynamicTcpPort;

    [Write, Description("Determines whether the alias should be added or removed. Default value is 'Present'"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;

    [Read, Description("Named Pipes path from the Get-TargetResource method.")] String PipeName;

};