Register-ClassificationInstance
Published 25 September 2019
Registers a single SQL Server instance.
Syntax
Register-ClassificationInstance [-FullyQualifiedInstanceName] <string> [-UserId <string>] [-Password <string>] [-DataScanningEnabled <bool>] [<CommonParameters>]
Description
Registers a single SQL Server instance to make it available within the SQL Data Catalog.
Parameters
-FullyQualifiedInstanceName
<String>
The fully-qualified name of the SQL Server instance to be registered. For a named instance, this should take the form 'fully-qualified-host-name\instance-name' (e.g. "myserver.mydomain.com\myinstance"). For the default instance on a machine, just the fully-qualified name of the machine will suffice (e.g. "myserver.mydomain.com").
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-UserId
<String>
Used only for SQL Server Authentication. Known also as "user name". Optional, do not provide for Windows Authentication.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Password
<String>
Used only for SQL Server Authentication. Optional, do not provide for Windows Authentication.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-DataScanningEnabled
<Boolean>
Enable data scanning and information type prediction for the instance. Optional, defaults to false.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | False |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
Register-ClassificationInstance -FullyQualifiedInstanceName 'mysqlserver.mydomain.com\myinstancename'
Registers an instance of SQL Server named "myinstancename" running on the "mysqlserver.mydomain.com" machine. Windows Authentication will be used to connect to this intance.
-------------------------- EXAMPLE 2 --------------------------
Register-ClassificationInstance -FullyQualifiedInstanceName 'mysqlserver.mydomain.com'
Registers the default instance of SQL Server running on the "mysqlserver.mydomain.com" machine. Windows Authentication will be used to connect to this intance.
-------------------------- EXAMPLE 3 --------------------------
Register-ClassificationInstance -FullyQualifiedInstanceName 'mysqlserver.mydomain.com\myinstancename' -UserId 'somebody' -Password 'myPassword'
Registers an instance of SQL Server named "myinstancename" running on the "mysqlserver.mydomain.com" machine. SQL Server Authentication will be used to connect to this intance.
-------------------------- EXAMPLE 4 --------------------------
@('dbserver1.mydomain.com', 'dbserver2.mydomain.com') | Register-ClassificationInstance
Demonstrates how multiple SQL Server instances in a list can be registered.
-------------------------- EXAMPLE 5 --------------------------
Get-Content -Path '.\myinstances.txt' | Register-ClassificationInstance
Demonstrates how the names of the instances to be registered can be taken from a simple text file. The file should contain one instance name per line.
