Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Azure NextGen
  5. synapse
  6. SqlPoolSensitivityLabel

SqlPoolSensitivityLabel

A sensitivity label.

Example Usage

Updates the sensitivity label of a given column with all parameters

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var sqlPoolSensitivityLabel = new AzureNextGen.Synapse.V20190601Preview.SqlPoolSensitivityLabel("sqlPoolSensitivityLabel", new AzureNextGen.Synapse.V20190601Preview.SqlPoolSensitivityLabelArgs
        {
            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",
        });
    }

}

package main

import (
    synapse "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/synapse/v20190601preview"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

sql_pool_sensitivity_label = azure_nextgen.synapse.v20190601preview.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")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const sqlPoolSensitivityLabel = new azure_nextgen.synapse.v20190601preview.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",
});

Create a SqlPoolSensitivityLabel Resource

new SqlPoolSensitivityLabel(name: string, args: SqlPoolSensitivityLabelArgs, opts?: CustomResourceOptions);
def SqlPoolSensitivityLabel(resource_name: str, opts: Optional[ResourceOptions] = None, column_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, resource_group_name: Optional[str] = None, schema_name: Optional[str] = None, sensitivity_label_source: Optional[str] = None, sql_pool_name: Optional[str] = None, table_name: Optional[str] = None, workspace_name: Optional[str] = None)
func NewSqlPoolSensitivityLabel(ctx *Context, name string, args SqlPoolSensitivityLabelArgs, opts ...ResourceOption) (*SqlPoolSensitivityLabel, error)
public SqlPoolSensitivityLabel(string name, SqlPoolSensitivityLabelArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SqlPoolSensitivityLabelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

SqlPoolSensitivityLabel Resource Properties

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

Inputs

The SqlPoolSensitivityLabel resource accepts the following input properties:

ColumnName string
The name of the column.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
SchemaName string
The name of the schema.
SensitivityLabelSource string
The source of the sensitivity label.
SqlPoolName string
SQL pool name
TableName string
The name of the table.
WorkspaceName 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.
ColumnName string
The name of the column.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
SchemaName string
The name of the schema.
SensitivityLabelSource string
The source of the sensitivity label.
SqlPoolName string
SQL pool name
TableName string
The name of the table.
WorkspaceName 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.
columnName string
The name of the column.
resourceGroupName string
The name of the resource group. The name is case insensitive.
schemaName string
The name of the schema.
sensitivityLabelSource string
The source of the sensitivity label.
sqlPoolName string
SQL pool name
tableName string
The name of the table.
workspaceName 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.
column_name str
The name of the column.
resource_group_name str
The name of the resource group. The name is case insensitive.
schema_name str
The name of the schema.
sensitivity_label_source str
The source of the sensitivity label.
sql_pool_name str
SQL pool name
table_name str
The name of the table.
workspace_name 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.

Outputs

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

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.
Name string
The name of the resource
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
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.
Name string
The name of the resource
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
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.
name string
The name of the resource
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
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.
name str
The name of the resource
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Import

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

$ pulumi import azure-nextgen:synapse/v20190601preview:SqlPoolSensitivityLabel current /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0