SQL Data Catalog

Add-ClassificationColumnTag

Add tags to a column for a given category.

Syntax

Add-ClassificationColumnTag [-Column] <Object> [-Category] <string> [[-Tags] <string[]>] [<CommonParameters>]

Description

Update column with the tags specified. Only one tag category will be updated.

- For a single-tag category, it will throw an error if the column has been assigned with a different tag.

- For a multi-tag category, tags provided will be added to already assigned tags.

Parameters

-Column <Object>

Column to update tags.

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input True (ByValue)
Accept Wildcard Characters false

-Category <String>

Name of tag category e.g. "Sensitivity".

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

-Tags <String[]>

Names of tags e.g. @("Confidential - GDPR") Can be used with multi tags e.g. @("GDPR", "HIPPA")

Aliases None
Required? false
Position? 3
Default Value None
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 --------------------------

$allColumns = Get-ClassificationColumn -instanceName "sqlserver\sql2016" -databaseName "WideWorldImporters"
$emailColumns  = $allColumns | Where-Object {$_.ColumnName -like "email"}
$emailColumns | Add-ClassificationColumnTag -category "Sensitivity" -tags @("Confidential - GDPR")
$emailColumns | Add-ClassificationColumnTag -category "Information Type" -tags @("Contact Info")

Updates all columns with name like email to "Sensitivity": "Confidential - GDPR" and "Information Type": "Contact Info".


Didn't find what you were looking for?