Data Masking Rules - Create Or Update

Tjänst:
SQL Database
API-version:
2025-01-01

Skapar eller uppdaterar en databas datamaskeringsregel.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules/{dataMaskingRuleName}?api-version=2025-01-01

URI-parametrar

Name I Obligatorisk Typ Description
databaseName
 path True

string

Namnet på databasen.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

Namnet på databasen där datamaskeringspolicyn gäller.
dataMaskingRuleName
 path True

string

Namnet på regeln för datamaskering.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName
 path True

string

Namnet på servern.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
properties.columnName True

string

Kolumnnamnet som datamaskningsregeln tillämpas på.
properties.maskingFunction True

DataMaskingFunction

Maskeringsfunktionen som används för datamaskeringsregeln.
properties.schemaName True

string

Schemanamnet som datamaskeringsregeln tillämpas på.
properties.tableName True

string

Tabellnamnet som datamaskeringsregeln tillämpas på.
properties.aliasName

string

Aliasnamnet. Det här är en äldre parameter och används inte längre.
properties.numberFrom

string

Egenskapen numberFrom för maskeringsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.numberTo

string

Egenskapen numberTo för datamaskningsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.prefixSize

string

Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i början av strängen. Annars ignoreras den här parametern.
properties.replacementString

string

Om maskingFunction är inställt på Text, tecknet som ska användas för maskering av den oexponerade delen av strängen. Annars ignoreras den här parametern.
properties.ruleState

DataMaskingRuleState

Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.
properties.suffixSize

string

Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i slutet av strängen. Annars ignoreras den här parametern.

Svar

Name Typ Description
200 OK

DataMaskingRule

Azure-operationen slutfördes framgångsrikt.
201 Created

DataMaskingRule

Resursen 'DataMaskingRule' skapade operationen lyckades
Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Create/Update data masking rule for default max.
Create/Update data masking rule for default min.
Create/Update data masking rule for numbers.
Create/Update data masking rule for text.

Create/Update data masking rule for default max.

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exempelsvar

Statuskod:
200 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Statuskod:
201 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for default min.

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Default",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exempelsvar

Statuskod:
200 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Statuskod:
201 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for numbers.

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exempelsvar

Statuskod:
200 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Statuskod:
201 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for text.

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "replacementString": "asdf",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Exempelsvar

Statuskod:
200 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}
Statuskod:
201 
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.
DataMaskingFunction

Maskeringsfunktionen som används för datamaskeringsregeln.
DataMaskingPolicyName
DataMaskingRule

En regel för databasdatamaskering.
DataMaskingRuleState

Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.
ErrorAdditionalInfo

Resurshanteringsfelet ytterligare information.
ErrorDetail

Detaljerna om felet.
ErrorResponse

Felsvar
systemData

Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Uppräkning

Maskeringsfunktionen som används för datamaskeringsregeln.

Värde Description
Default

Standardinställning
CCN

CCN
Email

E-postmeddelande
Number

Siffra
SSN

personnummer
Text

Text

DataMaskingPolicyName

Uppräkning
Värde Description
Default

Standardinställning

DataMaskingRule

Objekt

En regel för databasdatamaskering.

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

Den typen av datamaskeringsregel. Metadata, används för Azure Portal.
location

string

Platsen för datamaskeringsregeln.
name

string

Namnet på resursen
properties.aliasName

string

Aliasnamnet. Det här är en äldre parameter och används inte längre.
properties.columnName

string

Kolumnnamnet som datamaskningsregeln tillämpas på.
properties.id

string

Regeln är id.
properties.maskingFunction

DataMaskingFunction

Maskeringsfunktionen som används för datamaskeringsregeln.
properties.numberFrom

string

Egenskapen numberFrom för maskeringsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.numberTo

string

Egenskapen numberTo för datamaskningsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.prefixSize

string

Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i början av strängen. Annars ignoreras den här parametern.
properties.replacementString

string

Om maskingFunction är inställt på Text, tecknet som ska användas för maskering av den oexponerade delen av strängen. Annars ignoreras den här parametern.
properties.ruleState

DataMaskingRuleState

Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.
properties.schemaName

string

Schemanamnet som datamaskeringsregeln tillämpas på.
properties.suffixSize

string

Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i slutet av strängen. Annars ignoreras den här parametern.
properties.tableName

string

Tabellnamnet som datamaskeringsregeln tillämpas på.
systemData

systemData

Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
type

string

Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

DataMaskingRuleState

Uppräkning

Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.

Värde Description
Enabled

Aktiverad
Disabled

Inaktiverad

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name Typ Description
info

object

Den ytterligare informationen.
type

string

Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Felet ytterligare information.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felet objektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string (date-time)

Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.