Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getSensitivityLabel
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.sql.getSensitivityLabel

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

Gets the sensitivity label of a given column

Uses Azure REST API version 2023-08-01.

Other available API versions: 2017-03-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getSensitivityLabel

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSensitivityLabel(args: GetSensitivityLabelArgs, opts?: InvokeOptions): Promise<GetSensitivityLabelResult>
function getSensitivityLabelOutput(args: GetSensitivityLabelOutputArgs, opts?: InvokeOptions): Output<GetSensitivityLabelResult>
Copy
def get_sensitivity_label(column_name: Optional[str] = None,
                          database_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          schema_name: Optional[str] = None,
                          sensitivity_label_source: Optional[str] = None,
                          server_name: Optional[str] = None,
                          table_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSensitivityLabelResult
def get_sensitivity_label_output(column_name: Optional[pulumi.Input[str]] = None,
                          database_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          schema_name: Optional[pulumi.Input[str]] = None,
                          sensitivity_label_source: Optional[pulumi.Input[str]] = None,
                          server_name: Optional[pulumi.Input[str]] = None,
                          table_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSensitivityLabelResult]
Copy
func LookupSensitivityLabel(ctx *Context, args *LookupSensitivityLabelArgs, opts ...InvokeOption) (*LookupSensitivityLabelResult, error)
func LookupSensitivityLabelOutput(ctx *Context, args *LookupSensitivityLabelOutputArgs, opts ...InvokeOption) LookupSensitivityLabelResultOutput
Copy

> Note: This function is named LookupSensitivityLabel in the Go SDK.

public static class GetSensitivityLabel 
{
    public static Task<GetSensitivityLabelResult> InvokeAsync(GetSensitivityLabelArgs args, InvokeOptions? opts = null)
    public static Output<GetSensitivityLabelResult> Invoke(GetSensitivityLabelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSensitivityLabelResult> getSensitivityLabel(GetSensitivityLabelArgs args, InvokeOptions options)
public static Output<GetSensitivityLabelResult> getSensitivityLabel(GetSensitivityLabelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getSensitivityLabel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ColumnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SchemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
SensitivityLabelSource
This property is required.
Changes to this property will trigger replacement.
string
The source of the sensitivity label.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
ColumnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SchemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
SensitivityLabelSource
This property is required.
Changes to this property will trigger replacement.
string
The source of the sensitivity label.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
TableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
columnName
This property is required.
Changes to this property will trigger replacement.
String
The name of the column.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schema.
sensitivityLabelSource
This property is required.
Changes to this property will trigger replacement.
String
The source of the sensitivity label.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the table.
columnName
This property is required.
Changes to this property will trigger replacement.
string
The name of the column.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schema.
sensitivityLabelSource
This property is required.
Changes to this property will trigger replacement.
string
The source of the sensitivity label.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
tableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the table.
column_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the column.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schema_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the schema.
sensitivity_label_source
This property is required.
Changes to this property will trigger replacement.
str
The source of the sensitivity label.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
table_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the table.
columnName
This property is required.
Changes to this property will trigger replacement.
String
The name of the column.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schema.
sensitivityLabelSource
This property is required.
Changes to this property will trigger replacement.
String
The source of the sensitivity label.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
tableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the table.

getSensitivityLabel Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ColumnName string
The column name.
Id string
Resource ID.
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
Resource that manages the sensitivity label.
Name string
Resource name.
SchemaName string
The schema name.
TableName string
The table name.
Type string
Resource type.
ClientClassificationSource string
InformationType string
The information type.
InformationTypeId string
The information type ID.
LabelId string
The label ID.
LabelName string
The label name.
Rank string
AzureApiVersion string
The Azure API version of the resource.
ColumnName string
The column name.
Id string
Resource ID.
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
Resource that manages the sensitivity label.
Name string
Resource name.
SchemaName string
The schema name.
TableName string
The table name.
Type string
Resource type.
ClientClassificationSource string
InformationType string
The information type.
InformationTypeId string
The information type ID.
LabelId string
The label ID.
LabelName string
The label name.
Rank string
azureApiVersion String
The Azure API version of the resource.
columnName String
The column name.
id String
Resource ID.
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
Resource that manages the sensitivity label.
name String
Resource name.
schemaName String
The schema name.
tableName String
The table name.
type String
Resource type.
clientClassificationSource String
informationType String
The information type.
informationTypeId String
The information type ID.
labelId String
The label ID.
labelName String
The label name.
rank String
azureApiVersion string
The Azure API version of the resource.
columnName string
The column name.
id string
Resource ID.
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
Resource that manages the sensitivity label.
name string
Resource name.
schemaName string
The schema name.
tableName string
The table name.
type string
Resource type.
clientClassificationSource string
informationType string
The information type.
informationTypeId string
The information type ID.
labelId string
The label ID.
labelName string
The label name.
rank string
azure_api_version str
The Azure API version of the resource.
column_name str
The column name.
id str
Resource ID.
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
Resource that manages the sensitivity label.
name str
Resource name.
schema_name str
The schema name.
table_name str
The table name.
type str
Resource type.
client_classification_source str
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 str
azureApiVersion String
The Azure API version of the resource.
columnName String
The column name.
id String
Resource ID.
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
Resource that manages the sensitivity label.
name String
Resource name.
schemaName String
The schema name.
tableName String
The table name.
type String
Resource type.
clientClassificationSource String
informationType String
The information type.
informationTypeId String
The information type ID.
labelId String
The label ID.
labelName String
The label name.
rank String

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