Data Masking Rules - Create Or Update
Erstellt oder aktualisiert eine Datenbankdatenmaskenregel.
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-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
database
|
path | True |
string |
Der Name der Datenbank. |
|
data
|
path | True |
Der Name der Datenbank, für die die Datenformatierungsrichtlinie gilt. |
|
|
data
|
path | True |
string |
Der Name der Datenformatierungsregel. |
|
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen. |
|
server
|
path | True |
string |
Der Name des Servers. |
|
subscription
|
path | True |
string |
Die Abonnement-ID, die ein Azure-Abonnement identifiziert. |
|
api-version
|
query | True |
string |
Die API-Version, die für die Anforderung verwendet werden soll. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| properties.columnName | True |
string |
Der Spaltenname, auf den die Datenformatierungsregel angewendet wird. |
| properties.maskingFunction | True |
Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird. |
|
| properties.schemaName | True |
string |
Der Schemaname, auf den die Datenformatierungsregel angewendet wird. |
| properties.tableName | True |
string |
Der Tabellenname, auf den die Datenformatierungsregel angewendet wird. |
| properties.aliasName |
string |
Der Aliasname. Dies ist ein Legacyparameter und wird nicht mehr verwendet. |
|
| properties.numberFrom |
string |
Die numberFrom-Eigenschaft der Maskierungsregel. Erforderlich, wenn maskingFunction auf "Zahl" festgelegt ist, andernfalls wird dieser Parameter ignoriert. |
|
| properties.numberTo |
string |
Die NumberTo-Eigenschaft der Datenformatierungsregel. Erforderlich, wenn maskingFunction auf "Zahl" festgelegt ist, andernfalls wird dieser Parameter ignoriert. |
|
| properties.prefixSize |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird die Anzahl der Zeichen angezeigt, die am Anfang der Zeichenfolge ungemasket angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert. |
|
| properties.replacementString |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird das zeichen, das zum Maskieren des nicht exponierten Teils der Zeichenfolge verwendet werden soll. Andernfalls wird dieser Parameter ignoriert. |
|
| properties.ruleState |
Der Regelstatus. Wird zum Löschen einer Regel verwendet. Wenn Sie eine vorhandene Regel löschen möchten, geben Sie den schemaName, den Tabellenname, den ColumnName, das MaskingFunction-Element und den ruleState-Wert als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktivierter Regel erstellt, unabhängig vom bereitgestellten Wert von ruleState. |
||
| properties.suffixSize |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird die Anzahl der Zeichen angezeigt, die am Ende der Zeichenfolge unmasket angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Datenbankdatenformatierungsregel wurde erfolgreich festgelegt. |
|
| 201 Created |
Eine Datenbankdatenmaskenregel wurde erfolgreich erstellt. |
|
| Other Status Codes |
Fehlerantworten: ***
|
Beispiele
| 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.
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
{
"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.
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
{
"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.
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
{
"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.
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
{
"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"
}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Data |
Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird. |
|
Data |
Der Name der Datenbank, für die die Datenformatierungsrichtlinie gilt. |
|
Data |
Eine Datenbankdatenmaskenregel. |
|
Data |
Der Regelstatus. Wird zum Löschen einer Regel verwendet. Wenn Sie eine vorhandene Regel löschen möchten, geben Sie den schemaName, den Tabellenname, den ColumnName, das MaskingFunction-Element und den ruleState-Wert als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktivierter Regel erstellt, unabhängig vom bereitgestellten Wert von ruleState. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
DataMaskingFunction
Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird.
| Wert | Beschreibung |
|---|---|
| Default | |
| CCN | |
| Number | |
| SSN | |
| Text |
DataMaskingPolicyName
Der Name der Datenbank, für die die Datenformatierungsrichtlinie gilt.
| Wert | Beschreibung |
|---|---|
| Default |
DataMaskingRule
Eine Datenbankdatenmaskenregel.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Ressourcen-ID. |
| kind |
string |
Die Art der Datenformatierungsregel. Metadaten, die für das Azure-Portal verwendet werden. |
| location |
string |
Der Speicherort der Datenformatierungsregel. |
| name |
string |
Ressourcenname. |
| properties.aliasName |
string |
Der Aliasname. Dies ist ein Legacyparameter und wird nicht mehr verwendet. |
| properties.columnName |
string |
Der Spaltenname, auf den die Datenformatierungsregel angewendet wird. |
| properties.id |
string |
Die Regel-ID. |
| properties.maskingFunction |
Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird. |
|
| properties.numberFrom |
string |
Die numberFrom-Eigenschaft der Maskierungsregel. Erforderlich, wenn maskingFunction auf "Zahl" festgelegt ist, andernfalls wird dieser Parameter ignoriert. |
| properties.numberTo |
string |
Die NumberTo-Eigenschaft der Datenformatierungsregel. Erforderlich, wenn maskingFunction auf "Zahl" festgelegt ist, andernfalls wird dieser Parameter ignoriert. |
| properties.prefixSize |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird die Anzahl der Zeichen angezeigt, die am Anfang der Zeichenfolge ungemasket angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert. |
| properties.replacementString |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird das zeichen, das zum Maskieren des nicht exponierten Teils der Zeichenfolge verwendet werden soll. Andernfalls wird dieser Parameter ignoriert. |
| properties.ruleState |
Der Regelstatus. Wird zum Löschen einer Regel verwendet. Wenn Sie eine vorhandene Regel löschen möchten, geben Sie den schemaName, den Tabellenname, den ColumnName, das MaskingFunction-Element und den ruleState-Wert als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktivierter Regel erstellt, unabhängig vom bereitgestellten Wert von ruleState. |
|
| properties.schemaName |
string |
Der Schemaname, auf den die Datenformatierungsregel angewendet wird. |
| properties.suffixSize |
string |
Wenn maskingFunction auf "Text" festgelegt ist, wird die Anzahl der Zeichen angezeigt, die am Ende der Zeichenfolge unmasket angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert. |
| properties.tableName |
string |
Der Tabellenname, auf den die Datenformatierungsregel angewendet wird. |
| type |
string |
Ressourcentyp. |
DataMaskingRuleState
Der Regelstatus. Wird zum Löschen einer Regel verwendet. Wenn Sie eine vorhandene Regel löschen möchten, geben Sie den schemaName, den Tabellenname, den ColumnName, das MaskingFunction-Element und den ruleState-Wert als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktivierter Regel erstellt, unabhängig vom bereitgestellten Wert von ruleState.
| Wert | Beschreibung |
|---|---|
| Enabled | |
| Disabled |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |