Skip to content

Commit

Permalink
SqlServerDsc: Remove italic and inline code-block markdown code in do…
Browse files Browse the repository at this point in the history
…cumentation (#1584)
  • Loading branch information
johlju authored Jul 4, 2020
1 parent 41fab4a commit 8c150c7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- SqlServerDsc
- Update resource parameter documentation ([issue #1568](https://github.com/dsccommunity/SqlServerDsc/issues/1568)).
- Remove italic and inline code-block markdown code in documentation.
- Documentation is now published to the GitHub Wiki.
- Deploy task was updated with the correct name.
- Minor changes too schema property descriptions to generate documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
class DSC_SqlProtocolTcpIp : OMI_BaseResource
{
[Key, Description("Specifies the name of the SQL Server instance to manage the IP address group for.")] String InstanceName;
[Key, Description("Specifies the name of the IP address group in the TCP/IP protocol, e.g. `'IP1'`, 'IP2' etc., or 'IPAll'.")] String IpAddressGroup;
[Key, Description("Specifies the name of the IP address group in the TCP/IP protocol, e.g. 'IP1', 'IP2' etc., or 'IPAll'.")] String IpAddressGroup;
[Write, Description("Specifies the host name of the SQL Server to be configured. If the SQL Server belongs to a cluster or availability group specify the host name for the listener or cluster group. Default value is $env:COMPUTERNAME.")] String ServerName;
[Write, Description("Specified if the IP address group should be enabled or disabled. Only used if the IP address group is not set to 'IPAll'. If not specified, the existing value will not be changed.")] Boolean Enabled;
[Write, Description("Specifies the IP address for the IP adress group. Only used if the IP address group is not set to 'IPAll'. If not specified, the existing value will not be changed.")] String IpAddress;
[Write, Description("Specifies whether the SQL Server instance should use a dynamic port. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter _TcpPort_.")] Boolean UseTcpDynamicPort;
[Write, Description("Specifies whether the SQL Server instance should use a dynamic port. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter TcpPort.")] Boolean UseTcpDynamicPort;
[Write, Description("Specifies 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 as a string value with the port numbers separated with a comma, e.g. '1433,1500,1501'. This parameter is limited to 2047 characters. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter UseTcpDynamicPort.")] String TcpPort;
[Write, Description("If set to $true then the any attempt by the resource to restart the service is suppressed. The default value is $false.")] Boolean SuppressRestart;
[Write, Description("Timeout value for restarting the SQL Server services. The default value is 120 seconds.")] UInt16 RestartTimeout;
Expand Down

0 comments on commit 8c150c7

Please sign in to comment.