Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getDataMaskingPolicy
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getDataMaskingPolicy

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the database data masking policy.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2014-04-01, 2021-11-01, 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 getDataMaskingPolicy

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 getDataMaskingPolicy(args: GetDataMaskingPolicyArgs, opts?: InvokeOptions): Promise<GetDataMaskingPolicyResult>
function getDataMaskingPolicyOutput(args: GetDataMaskingPolicyOutputArgs, opts?: InvokeOptions): Output<GetDataMaskingPolicyResult>
Copy
def get_data_masking_policy(data_masking_policy_name: Optional[str] = None,
                            database_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            server_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDataMaskingPolicyResult
def get_data_masking_policy_output(data_masking_policy_name: Optional[pulumi.Input[str]] = None,
                            database_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            server_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetDataMaskingPolicyResult]
Copy
func LookupDataMaskingPolicy(ctx *Context, args *LookupDataMaskingPolicyArgs, opts ...InvokeOption) (*LookupDataMaskingPolicyResult, error)
func LookupDataMaskingPolicyOutput(ctx *Context, args *LookupDataMaskingPolicyOutputArgs, opts ...InvokeOption) LookupDataMaskingPolicyResultOutput
Copy

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

public static class GetDataMaskingPolicy 
{
    public static Task<GetDataMaskingPolicyResult> InvokeAsync(GetDataMaskingPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetDataMaskingPolicyResult> Invoke(GetDataMaskingPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDataMaskingPolicyResult> getDataMaskingPolicy(GetDataMaskingPolicyArgs args, InvokeOptions options)
public static Output<GetDataMaskingPolicyResult> getDataMaskingPolicy(GetDataMaskingPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getDataMaskingPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DataMaskingPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database for which the data masking policy applies.
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.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
DataMaskingPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database for which the data masking policy applies.
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.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
dataMaskingPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database for which the data masking policy applies.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
dataMaskingPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database for which the data masking policy applies.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
data_masking_policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database for which the data masking policy applies.
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.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
dataMaskingPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database for which the data masking policy applies.
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.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getDataMaskingPolicy Result

The following output properties are available:

ApplicationPrincipals string
The list of the application principals. This is a legacy parameter and is no longer used.
AzureApiVersion string
The Azure API version of the resource.
DataMaskingState string
The state of the data masking policy.
Id string
Resource ID.
Kind string
The kind of Data Masking Policy. Metadata, used for Azure portal.
Location string
The location of the data masking policy.
MaskingLevel string
The masking level. This is a legacy parameter and is no longer used.
Name string
Resource name.
Type string
Resource type.
ExemptPrincipals string
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
ApplicationPrincipals string
The list of the application principals. This is a legacy parameter and is no longer used.
AzureApiVersion string
The Azure API version of the resource.
DataMaskingState string
The state of the data masking policy.
Id string
Resource ID.
Kind string
The kind of Data Masking Policy. Metadata, used for Azure portal.
Location string
The location of the data masking policy.
MaskingLevel string
The masking level. This is a legacy parameter and is no longer used.
Name string
Resource name.
Type string
Resource type.
ExemptPrincipals string
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
applicationPrincipals String
The list of the application principals. This is a legacy parameter and is no longer used.
azureApiVersion String
The Azure API version of the resource.
dataMaskingState String
The state of the data masking policy.
id String
Resource ID.
kind String
The kind of Data Masking Policy. Metadata, used for Azure portal.
location String
The location of the data masking policy.
maskingLevel String
The masking level. This is a legacy parameter and is no longer used.
name String
Resource name.
type String
Resource type.
exemptPrincipals String
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
applicationPrincipals string
The list of the application principals. This is a legacy parameter and is no longer used.
azureApiVersion string
The Azure API version of the resource.
dataMaskingState string
The state of the data masking policy.
id string
Resource ID.
kind string
The kind of Data Masking Policy. Metadata, used for Azure portal.
location string
The location of the data masking policy.
maskingLevel string
The masking level. This is a legacy parameter and is no longer used.
name string
Resource name.
type string
Resource type.
exemptPrincipals string
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
application_principals str
The list of the application principals. This is a legacy parameter and is no longer used.
azure_api_version str
The Azure API version of the resource.
data_masking_state str
The state of the data masking policy.
id str
Resource ID.
kind str
The kind of Data Masking Policy. Metadata, used for Azure portal.
location str
The location of the data masking policy.
masking_level str
The masking level. This is a legacy parameter and is no longer used.
name str
Resource name.
type str
Resource type.
exempt_principals str
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
applicationPrincipals String
The list of the application principals. This is a legacy parameter and is no longer used.
azureApiVersion String
The Azure API version of the resource.
dataMaskingState String
The state of the data masking policy.
id String
Resource ID.
kind String
The kind of Data Masking Policy. Metadata, used for Azure portal.
location String
The location of the data masking policy.
maskingLevel String
The masking level. This is a legacy parameter and is no longer used.
name String
Resource name.
type String
Resource type.
exemptPrincipals String
The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native