SQL Data Catalog

Connect to SQL Data Catalog.

Syntax

Connect-SqlDataCatalog [-ServerUrl] <uri> [-AuthToken] <Object> [<CommonParameters>]

Description

Allows other commandlets to authenticate with the API. This cmdlet should be called once, before any other functions are called. This function takes an auth token as a parameter and temporarily stores it, to allow the other functions to authenticate with the API.

Parameters

`-ServerUrl <Uri>`

Url of the server where SQL Data Catalog is hosted.

Aliases	None
Required?	true
Position?	1
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-AuthToken <Object>`

Authentication token which can be obtained from the Web Client. Please refer to https://www.red-gate.com/data-catalog/working-with-rest-api for more information.

Aliases	None
Required?	true
Position?	2
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ProgressAction <ActionPreference>`

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 --------------------------

Import-Module .\RedgateDataCatalog.psm1
$server="http://localhost:15156"
$authToken="NjIzODE1Mjk5MjgzNTUwMjA4OjVhNzkyNWE0LGA4OjQtNGM1ZC1hOGY4LTJhMzM2ODk0M2NaBc=="
Connect-SqlDataCatalog -ServerUrl $server -AuthToken $authToken

Allows other commandlets to authenticate with the API using $AuthToken parameter.