Data Masking Rules - Create Or Update

Service:

SQL Database

API-versie:

2023-08-01

Hiermee maakt of werkt u een databasegegevensmaskeringsregel bij.

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

URI-parameters

Name	In	Vereist	Type	Description
databaseName	path	True	string	De naam van de database.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	De naam van de database waarvoor het beleid voor gegevensmaskering van toepassing is.
dataMaskingRuleName	path	True	string	De naam van de gegevensmaskeringsregel.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
properties.columnName	True	string	De kolomnaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.maskingFunction	True	DataMaskingFunction	De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.
properties.schemaName	True	string	De schemanaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.tableName	True	string	De tabelnaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.aliasName		string	De aliasnaam. Dit is een verouderde parameter en wordt niet meer gebruikt.
properties.numberFrom		string	De eigenschap numberFrom van de maskeringsregel. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.numberTo		string	De eigenschap NumberTo van de regel voor gegevensmaskering. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.prefixSize		string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat niet wordt gemaskeerd aan het begin van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.replacementString		string	Als maskingFunction is ingesteld op Tekst, moet het teken worden gebruikt voor het maskeren van het niet-belichte deel van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.ruleState		DataMaskingRuleState	De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.
properties.suffixSize		string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat aan het einde van de tekenreeks niet wordt gemaskeerd. Anders wordt deze parameter genegeerd.

Antwoorden

Name	Type	Description
200 OK	DataMaskingRule	Stel een databasegegevensmaskeringsregel in.
201 Created	DataMaskingRule	Er is een databasegegevensmaskeringsregel gemaakt.
Other Status Codes	ErrorResponse	Foutreacties: *** 400 InvalidDatabaseNameForDataMaskingOperation : het is niet mogelijk om beleid en regels voor gegevensmaskering rechtstreeks toe te passen op de hoofddatabase. Beleid/regels voor gegevensmaskering zijn alleen van toepassing op de gebruikersdatabase.

Voorbeelden

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.

Voorbeeldaanvraag

HTTP

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=2023-08-01

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Create/Update data masking rule for default min.

Voorbeeldaanvraag

HTTP

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=2023-08-01

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Create/Update data masking rule for numbers.

Voorbeeldaanvraag

HTTP

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=2023-08-01

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Create/Update data masking rule for text.

Voorbeeldaanvraag

HTTP

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=2023-08-01

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Definities

Name	Description
DataMaskingFunction	De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.
DataMaskingPolicyName	De naam van de database waarvoor het beleid voor gegevensmaskering van toepassing is.
DataMaskingRule	Een regel voor het maskeren van databasegegevens.
DataMaskingRuleState	De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

DataMaskingFunction

Inventarisatie

De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.

Waarde	Description
CCN
Default
Email
Number
SSN
Text

DataMaskingPolicyName

Inventarisatie

De naam van de database waarvoor het beleid voor gegevensmaskering van toepassing is.

Waarde	Description
Default

DataMaskingRule

Object

Een regel voor het maskeren van databasegegevens.

Name	Type	Description
id	string	Resource-id.
kind	string	Het soort gegevensmaskeringsregel. Metagegevens, die worden gebruikt voor Azure Portal.
location	string	De locatie van de regel voor gegevensmaskering.
name	string	Resourcenaam.
properties.aliasName	string	De aliasnaam. Dit is een verouderde parameter en wordt niet meer gebruikt.
properties.columnName	string	De kolomnaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.id	string	De regel-id.
properties.maskingFunction	DataMaskingFunction	De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.
properties.numberFrom	string	De eigenschap numberFrom van de maskeringsregel. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.numberTo	string	De eigenschap NumberTo van de regel voor gegevensmaskering. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.prefixSize	string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat niet wordt gemaskeerd aan het begin van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.replacementString	string	Als maskingFunction is ingesteld op Tekst, moet het teken worden gebruikt voor het maskeren van het niet-belichte deel van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.ruleState	DataMaskingRuleState	De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.
properties.schemaName	string	De schemanaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.suffixSize	string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat aan het einde van de tekenreeks niet wordt gemaskeerd. Anders wordt deze parameter genegeerd.
properties.tableName	string	De tabelnaam waarop de gegevensmaskeringsregel wordt toegepast.
type	string	Resourcetype.

DataMaskingRuleState

Inventarisatie

De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.

Waarde	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.