Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. SqlPoolSensitivityLabel
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.SqlPoolSensitivityLabel

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A sensitivity label.

Uses Azure REST API version 2021-06-01. In version 2.x of the Azure Native provider, it used API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Example Usage

Updates the sensitivity label of a given column with all parameters

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlPoolSensitivityLabel = new AzureNative.Synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabel", new()
    {
        ColumnName = "myColumn",
        InformationType = "PhoneNumber",
        InformationTypeId = "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        LabelId = "bf91e08c-f4f0-478a-b016-25164b2a65ff",
        LabelName = "PII",
        ResourceGroupName = "myRG",
        SchemaName = "dbo",
        SensitivityLabelSource = "current",
        SqlPoolName = "myDatabase",
        TableName = "myTable",
        WorkspaceName = "myServer",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewSqlPoolSensitivityLabel(ctx, "sqlPoolSensitivityLabel", &synapse.SqlPoolSensitivityLabelArgs{
			ColumnName:             pulumi.String("myColumn"),
			InformationType:        pulumi.String("PhoneNumber"),
			InformationTypeId:      pulumi.String("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
			LabelId:                pulumi.String("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
			LabelName:              pulumi.String("PII"),
			ResourceGroupName:      pulumi.String("myRG"),
			SchemaName:             pulumi.String("dbo"),
			SensitivityLabelSource: pulumi.String("current"),
			SqlPoolName:            pulumi.String("myDatabase"),
			TableName:              pulumi.String("myTable"),
			WorkspaceName:          pulumi.String("myServer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.SqlPoolSensitivityLabel;
import com.pulumi.azurenative.synapse.SqlPoolSensitivityLabelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sqlPoolSensitivityLabel = new SqlPoolSensitivityLabel("sqlPoolSensitivityLabel", SqlPoolSensitivityLabelArgs.builder()
            .columnName("myColumn")
            .informationType("PhoneNumber")
            .informationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")
            .labelId("bf91e08c-f4f0-478a-b016-25164b2a65ff")
            .labelName("PII")
            .resourceGroupName("myRG")
            .schemaName("dbo")
            .sensitivityLabelSource("current")
            .sqlPoolName("myDatabase")
            .tableName("myTable")
            .workspaceName("myServer")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlPoolSensitivityLabel = new azure_native.synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabel", {
    columnName: "myColumn",
    informationType: "PhoneNumber",
    informationTypeId: "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    labelId: "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    labelName: "PII",
    resourceGroupName: "myRG",
    schemaName: "dbo",
    sensitivityLabelSource: "current",
    sqlPoolName: "myDatabase",
    tableName: "myTable",
    workspaceName: "myServer",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sql_pool_sensitivity_label = azure_native.synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabel",
    column_name="myColumn",
    information_type="PhoneNumber",
    information_type_id="d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    label_id="bf91e08c-f4f0-478a-b016-25164b2a65ff",
    label_name="PII",
    resource_group_name="myRG",
    schema_name="dbo",
    sensitivity_label_source="current",
    sql_pool_name="myDatabase",
    table_name="myTable",
    workspace_name="myServer")
Copy
resources:
  sqlPoolSensitivityLabel:
    type: azure-native:synapse:SqlPoolSensitivityLabel
    properties:
      columnName: myColumn
      informationType: PhoneNumber
      informationTypeId: d22fa6e9-5ee4-3bde-4c2b-a409604c4646
      labelId: bf91e08c-f4f0-478a-b016-25164b2a65ff
      labelName: PII
      resourceGroupName: myRG
      schemaName: dbo
      sensitivityLabelSource: current
      sqlPoolName: myDatabase
      tableName: myTable
      workspaceName: myServer
Copy

Create SqlPoolSensitivityLabel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SqlPoolSensitivityLabel(name: string, args: SqlPoolSensitivityLabelArgs, opts?: CustomResourceOptions);
@overload
def SqlPoolSensitivityLabel(resource_name: str,
                            args: SqlPoolSensitivityLabelArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def SqlPoolSensitivityLabel(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            column_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            schema_name: Optional[str] = None,
                            sql_pool_name: Optional[str] = None,
                            table_name: Optional[str] = None,
                            workspace_name: Optional[str] = None,
                            information_type: Optional[str] = None,
                            information_type_id: Optional[str] = None,
                            label_id: Optional[str] = None,
                            label_name: Optional[str] = None,
                            rank: Optional[SensitivityLabelRank] = None,
                            sensitivity_label_source: Optional[str] = None)
func NewSqlPoolSensitivityLabel(ctx *Context, name string, args SqlPoolSensitivityLabelArgs, opts ...ResourceOption) (*SqlPoolSensitivityLabel, error)
public SqlPoolSensitivityLabel(string name, SqlPoolSensitivityLabelArgs args, CustomResourceOptions? opts = null)
public SqlPoolSensitivityLabel(String name, SqlPoolSensitivityLabelArgs args)
public SqlPoolSensitivityLabel(String name, SqlPoolSensitivityLabelArgs args, CustomResourceOptions options)

type: azure-native:synapse:SqlPoolSensitivityLabel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SqlPoolSensitivityLabelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sqlPoolSensitivityLabelResource = new AzureNative.Synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabelResource", new()
{
    ColumnName = "string",
    ResourceGroupName = "string",
    SchemaName = "string",
    SqlPoolName = "string",
    TableName = "string",
    WorkspaceName = "string",
    InformationType = "string",
    InformationTypeId = "string",
    LabelId = "string",
    LabelName = "string",
    Rank = AzureNative.Synapse.SensitivityLabelRank.None,
    SensitivityLabelSource = "string",
});
Copy
example, err := synapse.NewSqlPoolSensitivityLabel(ctx, "sqlPoolSensitivityLabelResource", &synapse.SqlPoolSensitivityLabelArgs{
	ColumnName:             pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	SchemaName:             pulumi.String("string"),
	SqlPoolName:            pulumi.String("string"),
	TableName:              pulumi.String("string"),
	WorkspaceName:          pulumi.String("string"),
	InformationType:        pulumi.String("string"),
	InformationTypeId:      pulumi.String("string"),
	LabelId:                pulumi.String("string"),
	LabelName:              pulumi.String("string"),
	Rank:                   synapse.SensitivityLabelRankNone,
	SensitivityLabelSource: pulumi.String("string"),
})
Copy
var sqlPoolSensitivityLabelResource = new SqlPoolSensitivityLabel("sqlPoolSensitivityLabelResource", SqlPoolSensitivityLabelArgs.builder()
    .columnName("string")
    .resourceGroupName("string")
    .schemaName("string")
    .sqlPoolName("string")
    .tableName("string")
    .workspaceName("string")
    .informationType("string")
    .informationTypeId("string")
    .labelId("string")
    .labelName("string")
    .rank("None")
    .sensitivityLabelSource("string")
    .build());
Copy
sql_pool_sensitivity_label_resource = azure_native.synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabelResource",
    column_name="string",
    resource_group_name="string",
    schema_name="string",
    sql_pool_name="string",
    table_name="string",
    workspace_name="string",
    information_type="string",
    information_type_id="string",
    label_id="string",
    label_name="string",
    rank=azure_native.synapse.SensitivityLabelRank.NONE,
    sensitivity_label_source="string")
Copy
const sqlPoolSensitivityLabelResource = new azure_native.synapse.SqlPoolSensitivityLabel("sqlPoolSensitivityLabelResource", {
    columnName: "string",
    resourceGroupName: "string",
    schemaName: "string",
    sqlPoolName: "string",
    tableName: "string",
    workspaceName: "string",
    informationType: "string",
    informationTypeId: "string",
    labelId: "string",
    labelName: "string",
    rank: azure_native.synapse.SensitivityLabelRank.None,
    sensitivityLabelSource: "string",
});
Copy
type: azure-native:synapse:SqlPoolSensitivityLabel
properties:
    columnName: string
    informationType: string
    informationTypeId: string
    labelId: string
    labelName: string
    rank: None
    resourceGroupName: string
    schemaName: string
    sensitivityLabelSource: string
    sqlPoolName: string
    tableName: string
    workspaceName: string
Copy

SqlPoolSensitivityLabel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SqlPoolSensitivityLabel resource accepts the following input properties:

ColumnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SchemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
SqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
InformationType string
The information type.
InformationTypeId string
The information type ID.
LabelId string
The label ID.
LabelName string
The label name.
Rank Pulumi.AzureNative.Synapse.SensitivityLabelRank
SensitivityLabelSource Changes to this property will trigger replacement. string
The source of the sensitivity label.
ColumnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SchemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
SqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
InformationType string
The information type.
InformationTypeId string
The information type ID.
LabelId string
The label ID.
LabelName string
The label name.
Rank SensitivityLabelRank
SensitivityLabelSource Changes to this property will trigger replacement. string
The source of the sensitivity label.
columnName
This property is required.
Changes to this property will trigger replacement.
String
The name of the column.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
schemaName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schema.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
String
SQL pool name
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the table.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
informationType String
The information type.
informationTypeId String
The information type ID.
labelId String
The label ID.
labelName String
The label name.
rank SensitivityLabelRank
sensitivityLabelSource Changes to this property will trigger replacement. String
The source of the sensitivity label.
columnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
schemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
tableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
informationType string
The information type.
informationTypeId string
The information type ID.
labelId string
The label ID.
labelName string
The label name.
rank SensitivityLabelRank
sensitivityLabelSource Changes to this property will trigger replacement. string
The source of the sensitivity label.
column_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the column.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
schema_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the schema.
sql_pool_name
This property is required.
Changes to this property will trigger replacement.
str
SQL pool name
table_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the table.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
information_type str
The information type.
information_type_id str
The information type ID.
label_id str
The label ID.
label_name str
The label name.
rank SensitivityLabelRank
sensitivity_label_source Changes to this property will trigger replacement. str
The source of the sensitivity label.
columnName
This property is required.
Changes to this property will trigger replacement.
String
The name of the column.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
schemaName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schema.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
String
SQL pool name
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the table.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
informationType String
The information type.
informationTypeId String
The information type ID.
labelId String
The label ID.
labelName String
The label name.
rank "None" | "Low" | "Medium" | "High" | "Critical"
sensitivityLabelSource Changes to this property will trigger replacement. String
The source of the sensitivity label.

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlPoolSensitivityLabel resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDisabled bool
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
ManagedBy string
managed by
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDisabled bool
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
ManagedBy string
managed by
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDisabled Boolean
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
managedBy String
managed by
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
isDisabled boolean
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
managedBy string
managed by
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
is_disabled bool
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
managed_by str
managed by
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDisabled Boolean
Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
managedBy String
managed by
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SensitivityLabelRank
, SensitivityLabelRankArgs

None
None
Low
Low
Medium
Medium
High
High
Critical
Critical
SensitivityLabelRankNone
None
SensitivityLabelRankLow
Low
SensitivityLabelRankMedium
Medium
SensitivityLabelRankHigh
High
SensitivityLabelRankCritical
Critical
None
None
Low
Low
Medium
Medium
High
High
Critical
Critical
None
None
Low
Low
Medium
Medium
High
High
Critical
Critical
NONE
None
LOW
Low
MEDIUM
Medium
HIGH
High
CRITICAL
Critical
"None"
None
"Low"
Low
"Medium"
Medium
"High"
High
"Critical"
Critical

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:synapse:SqlPoolSensitivityLabel current /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native