SqlServerDsc

15.2.0

DSCResources/MSFT_SqlServerNetwork/MSFT_SqlServerNetwork.schema.mof

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

class MSFT_SqlServerNetwork : OMI_BaseResource

{

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

    [Required, Description("The name of network protocol to be configured. Only tcp is currently supported."), ValueMap{"Tcp"}, Values{"Tcp"}] String ProtocolName;

    [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;

    [Write, Description("Enables or disables the network protocol.")] Boolean IsEnabled;

    [Write, Description("Specifies whether the SQL Server instance should use a dynamic port. Value cannot be set to 'True' if TcpPort is set to a non-empty string.")] Boolean TcpDynamicPort;

    [Write, Description("The TCP port(s) that SQL Server should be listening on. If the IP address should listen on more than one port, list all ports separated with a comma ('1433,1500,1501'). To use this parameter set TcpDynamicPorts to 'False'.")] String TcpPort;

    [Write, Description("If set to $true then SQL Server and dependent services will be restarted if a change to the configuration is made. The default value is $false.")] Boolean RestartService;

    [Write, Description("Timeout value for restarting the SQL Server services. The default value is 120 seconds.")] UInt16 RestartTimeout;

};