Set-SqlSensitivityClassification

Reference

Module:: SQLServer

Set the information type and/or sensitivity label and information type of columns in the database.

Syntax

Set-SqlSensitivityClassification
   -ColumnName <String[]>
   [-SuppressProviderContextWarning]
   [-SensitivityRank <SensitivityRank>]
   [-ProgressAction <ActionPreference>]
   [-InformationType <String>]
   [-SensitivityLabel <String>]
   [<CommonParameters>]

Set-SqlSensitivityClassification
   -ColumnName <String[]>
   -ConnectionString <String>
   [-SensitivityRank <SensitivityRank>]
   [-ProgressAction <ActionPreference>]
   [-InformationType <String>]
   [-SensitivityLabel <String>]
   [<CommonParameters>]

Set-SqlSensitivityClassification
   -ColumnName <String[]>
   -ServerInstance <PSObject>
   -DatabaseName <String>
   [-Credential <PSCredential>]
   [-SensitivityRank <SensitivityRank>]
   [-ProgressAction <ActionPreference>]
   [-InformationType <String>]
   [-SensitivityLabel <String>]
   [<CommonParameters>]

Set-SqlSensitivityClassification
   -ColumnName <String[]>
   -Path <String>
   [-SensitivityRank <SensitivityRank>]
   [-ProgressAction <ActionPreference>]
   [-InformationType <String>]
   [-SensitivityLabel <String>]
   [<CommonParameters>]

Set-SqlSensitivityClassification
   -ColumnName <String[]>
   -InputObject <Database>
   [-SensitivityRank <SensitivityRank>]
   [-ProgressAction <ActionPreference>]
   [-InformationType <String>]
   [-SensitivityLabel <String>]
   [<CommonParameters>]

Description

The Set-SqlSensitivityClassification cmdlet sets the information type and/or Sensitivity label of columns in the database.

The information type and sensitivity label and information type of columns also be set using SQL Server Management Studio (SSMS) release 17.5 and above.

The information type and sensitivity label and information type of columns can be viewed using SQL Server Management Studio (SSMS) release 17.5 and above, the Extended Properties catalog view, or the Get-SqlSensitivityClassification cmdlet.

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

Examples

Example 1: Set information type and sensitivity label on a single column using Windows authentication

PS C:\> Set-SqlSensitivityClassification -ServerInstance "MyComputer\MainInstance" -Database "myDatabase" -ColumnName "Sales.Customers.first_name" -InformationType "Name" -SensitivityLabel "Confidential - GDPR" -SensitivityRank "Low"

Column                      InformationType SensitivityLabel    SensitivityRank
------                      --------------- ----------------    ---------------
Sales.Customers.first_name  Name            Confidential - GDPR Low

Set the information type and sensitivity label of column Sales.Customers.first_name to Name and Confidential - GDPR respectively. The values for information type and sensitivity label are limited to the default values provided below, and can be obtained by using the Tab key.

Example 2: Set the information type of a single column using Windows authentication

PS C:\> Set-SqlSensitivityClassification -ServerInstance "MyComputer\MainInstance" -Database "myDatabase" -ColumnName "Sales.Customers.first_name" -InformationType "Personal"

Column                      InformationType SensitivityLabel SensitivityRank
------                      --------------- ---------------- ---------------
Sales.Customers.first_name  Personal

Set the information type of column Sales.Customers.first_name to Personal. The sensitivity label will be unset if it was previously set.

Example 3: Set the sensitivity label of a single column using connection parameters

PS C:\> Set-SqlSensitivityClassification -ServerInstance "MyComputer\MainInstance" -Database "myDatabase" -Credential (Get-Credential "sa") -ColumnName "Sales.Customers.ip_address" -SensitivityLabel "Confidential"

Column                      InformationType SensitivityLabel SensitivityRank
------                      --------------- ---------------- ---------------
Sales.Customers.ip_address                  Confidential

Set the sensitivity label of column Sales.Customers.ip_address to Confidential using the SQL Server login. The information type for this column remains unset. This command prompts you for a password to complete the authentication.

Example 4: Set the information type and classification label of multiple columns using current path context

PS C:\> $columns = @("Sales.Customers.first_name" , "Sales.Customers.last_name")
PS C:\> Set-Location "SQLSERVER:\SQL\MyComputer\MainInstance\Databases\MyDatabase"
PS SQLSERVER:\SQL\MyComputer\MainInstance> Set-SqlSensitivityClassification -ColumnName $columns -InformationType "Name" -SensitivityLabel "Confidential - GDPR" -SensitivityRank "Critical"
 WARNING: Using provider context. Server = MyComputer, Database = MyDatabase.

Column                      InformationType SensitivityLabel    SensitivityRank
------                      --------------- ----------------    ---------------
Sales.Customers.first_name  Name            Confidential - GDPR Critical
Sales.Customers.last_name   Name            Confidential - GDPR Critical

Set the information type and sensitivity label of column Sales.Customers.first_name and Sales.Customers.last_name by providing array of column names as argument to the cmdlet. All columns will receive the same information type and sensitivity label. Database connection information is taken from the context that is created by Set-Location.

Parameters

-ColumnName

Name(s) of columns for which information type and sensitivity label is set.

Type:	String[]
Aliases:	Column
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ConnectionString

Specifies a connection string to connect to the database. If this parameter is present, other connection parameters will be ignored

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies a credential used to connect to the database.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Specifies the name of a database. This cmdlet connects to this database in the instance that is specified in the ServerInstance parameter.

If the DatabaseName parameter is not specified, the database that is used depends on whether the current path specifies both the SQLSERVER:\SQL folder and a database name. If the path specifies both the SQL folder and a database name, this cmdlet connects to the database that is specified in the path.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationType

A name that describes the information type that is stored in the column(s). You must provide a value for SensitivityLabel, InformationType, or both. Possible values are limited and cannot be extended.

Type:	String
Accepted values:	Networking, Contact Info, Credentials, Credit Card, Banking, Financial, Other, Name, National ID, SSN, Health, Date Of Birth
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Specifies a SQL Server Management Object (SMO) that represent the database that this cmdlet uses.

Type:	Database
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

Specifies the path to the instance of SQL Server on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SensitivityLabel

A name that describes the sensitivity of the data that is stored in the column(s). You must provide a value for SensitivityLabel, InformationType, or both. Possible values are limited and cannot be extended.

Type:	String
Accepted values:	Public, General, Confidential, Confidential - GDPR, Highly Confidential, Highly Confidential - GDPR
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SensitivityRank

An identifier based on a predefinied set of values which define sensitivity rank. May be used by other services like Advanced Threat Protection to detect anomalies based on their rank

Type:	SensitivityRank
Accepted values:	None, Low, Medium, High, Critical
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServerInstance

Specifies either the name of the server instance (a string) or SQL Server Management Objects (SMO) object that specifies the name of an instance of the Database Engine. For default instances, only specify the computer name: MyComputer. For named instances, use the format ComputerName\InstanceName.

Type:	PSObject
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SuppressProviderContextWarning

Indicates that this cmdlet suppresses the warning that this cmdlet has used in the database context from the current SQLSERVER:\SQL path setting to establish the database context for the cmdlet.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.String[]

Microsoft.SqlServer.Management.Smo.Database

System.String

Outputs

System.Object

SQL Data Discovery and Classification

Share via

Set-SqlSensitivityClassification

Syntax

Description

Examples

Example 1: Set information type and sensitivity label on a single column using Windows authentication

Example 2: Set the information type of a single column using Windows authentication

Example 3: Set the sensitivity label of a single column using connection parameters

Example 4: Set the information type and classification label of multiple columns using current path context

Parameters

-ColumnName

-ConnectionString

-Credential

-DatabaseName

-InformationType

-InputObject

-Path

-ProgressAction

-SensitivityLabel

-SensitivityRank

-ServerInstance

-SuppressProviderContextWarning

Inputs

Outputs

Feedback

Additional resources

Share via

Set-SqlSensitivityClassification

Syntax

Description

Examples

Example 1: Set information type and sensitivity label on a single column using Windows authentication

Example 2: Set the information type of a single column using Windows authentication

Example 3: Set the sensitivity label of a single column using connection parameters

Example 4: Set the information type and classification label of multiple columns using current path context

Parameters

-ColumnName

-ConnectionString

-Credential

-DatabaseName

-InformationType

-InputObject

-Path

-ProgressAction

-SensitivityLabel

-SensitivityRank

-ServerInstance

-SuppressProviderContextWarning

Inputs

Outputs

Related Links

Feedback

Additional resources