Condividi tramite


Data Masking Rules - Create Or Update

Crea o aggiorna una regola di maschera dati del database.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
databaseName
path True

string

Nome del database.

dataMaskingPolicyName
path True

DataMaskingPolicyName

Nome del database per cui si applicano i criteri di maschera dati.

dataMaskingRuleName
path True

string

Nome della regola di maschera dati.

resourceGroupName
path True

string

Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.

serverName
path True

string

Nome del server.

subscriptionId
path True

string

ID sottoscrizione che identifica una sottoscrizione di Azure.

api-version
query True

string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.columnName True

string

Nome della colonna in cui viene applicata la regola di maschera dati.

properties.maskingFunction True

DataMaskingFunction

Funzione di maschera utilizzata per la regola di maschera dati.

properties.schemaName True

string

Nome dello schema in cui viene applicata la regola di maschera dati.

properties.tableName True

string

Nome della tabella in cui viene applicata la regola di maschera dati.

properties.aliasName

string

Nome alias. Si tratta di un parametro legacy e non viene più usato.

properties.numberFrom

string

Proprietà numberFrom della regola di mascheramento. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.

properties.numberTo

string

Proprietà numberTo della regola di maschera dati. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.

properties.prefixSize

string

Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato all'inizio della stringa. In caso contrario, questo parametro verrà ignorato.

properties.replacementString

string

Se maskingFunction è impostato su Text, il carattere da utilizzare per mascherare la parte non esposta della stringa. In caso contrario, questo parametro verrà ignorato.

properties.ruleState

DataMaskingRuleState

Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.

properties.suffixSize

string

Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato alla fine della stringa. In caso contrario, questo parametro verrà ignorato.

Risposte

Nome Tipo Descrizione
200 OK

DataMaskingRule

Impostare correttamente una regola di maschera dati del database.

201 Created

DataMaskingRule

Creazione di una regola di maschera dati del database completata.

Other Status Codes

ErrorResponse

Risposte di errore:

  • 400 InvalidDatabaseNameForDataMaskingOperation: non è possibile applicare criteri e regole di maschera dati direttamente al database master. I criteri o le regole di maschera dati sono applicabili solo al database utente.

Esempio

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.

Esempio di richiesta

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"
  }
}

Risposta di esempio

{
  "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
  }
}
{
  "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.

Esempio di richiesta

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"
  }
}

Risposta di esempio

{
  "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
  }
}
{
  "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.

Esempio di richiesta

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"
  }
}

Risposta di esempio

{
  "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
  }
}
{
  "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.

Esempio di richiesta

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"
  }
}

Risposta di esempio

{
  "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"
  }
}
{
  "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"
  }
}

Definizioni

Nome Descrizione
DataMaskingFunction

Funzione di maschera utilizzata per la regola di maschera dati.

DataMaskingPolicyName

Nome del database per cui si applicano i criteri di maschera dati.

DataMaskingRule

Regola di maschera dati del database.

DataMaskingRuleState

Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

DataMaskingFunction

Funzione di maschera utilizzata per la regola di maschera dati.

Valore Descrizione
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

Nome del database per cui si applicano i criteri di maschera dati.

Valore Descrizione
Default

DataMaskingRule

Regola di maschera dati del database.

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di regola di maschera dati. Metadati, usati per il portale di Azure.

location

string

Posizione della regola di maschera dati.

name

string

Nome risorsa.

properties.aliasName

string

Nome alias. Si tratta di un parametro legacy e non viene più usato.

properties.columnName

string

Nome della colonna in cui viene applicata la regola di maschera dati.

properties.id

string

ID regola.

properties.maskingFunction

DataMaskingFunction

Funzione di maschera utilizzata per la regola di maschera dati.

properties.numberFrom

string

Proprietà numberFrom della regola di mascheramento. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.

properties.numberTo

string

Proprietà numberTo della regola di maschera dati. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.

properties.prefixSize

string

Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato all'inizio della stringa. In caso contrario, questo parametro verrà ignorato.

properties.replacementString

string

Se maskingFunction è impostato su Text, il carattere da utilizzare per mascherare la parte non esposta della stringa. In caso contrario, questo parametro verrà ignorato.

properties.ruleState

DataMaskingRuleState

Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.

properties.schemaName

string

Nome dello schema in cui viene applicata la regola di maschera dati.

properties.suffixSize

string

Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato alla fine della stringa. In caso contrario, questo parametro verrà ignorato.

properties.tableName

string

Nome della tabella in cui viene applicata la regola di maschera dati.

type

string

Tipo di risorsa.

DataMaskingRuleState

Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.

Valore Descrizione
Enabled
Disabled

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.