SqlAliases manages the SQL Server Configuration Options on a SQL Server instance.
Source |
|
DSC Resource |
|
Documentation |
-
Target machine must be running Windows Server 2012 or later.
-
Target machine must be running SQL Server Database Engine 2012 or later.
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Mandatory |
Hashtable[] |
List of SQL aliases. |
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name |
Key |
String |
The name of Alias (e.g. |
|
Protocol |
String |
Protocol to use when connecting. Valid values are |
|
|
ServerName |
String |
The SQL Server you are aliasing. This should be set to the NetBIOS name or fully qualified domain name (FQDN). |
||
TcpPort |
UInt16 |
The TCP port the SQL Server instance is listening on. Only used when Protocol is set to |
Default: |
|
UseDynamicTcpPort |
Bool |
Specifies that the Net-Library will determine the port dynamically. The port number specified in Port will be ignored. |
|
|
Enure |
String |
Determines whether the alias should be added ( |
|
|
PipeName |
String |
Returns the Named Pipes path if Protocol is set to |
SqlConfiguration:
Values:
- ServerName : SQL001.contoso.com
Name : SQLSERVER
Protocol : TCP
UseDynamicTcpPort : true
TcpPort : false