Data Masking Rules - List By Database

Referenz

Dienst:: SQL Database

API-Version:: 2023-08-01

Ruft eine Liste der Regeln für die Datenbankdatenmaske ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Der Name der Datenbank, für die die Datenformatierungsregel gilt.
resourceGroupName	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.
serverName	path	True	string	Der Name des Servers.
subscriptionId	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.

Antworten

Name	Typ	Beschreibung
200 OK	DataMaskingRuleListResult	Die Liste der Advanced Threat Protection-Status des Servers wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: ***

Beispiele

Gets a list of database data masking rules.

Beispielanforderung

HTTP

GET 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?api-version=2023-08-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "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": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "suffixSize": null,
        "replacementString": null
      }
    }
  ]
}

Definitionen

Name	Beschreibung
DataMaskingFunction	Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird.
DataMaskingPolicyName	Der Name der Datenbank, für die die Datenformatierungsregel gilt.
DataMaskingRule	Eine Datenbankdatenmaskenregel.
DataMaskingRuleListResult	Die Liste der Regeln für datenbankdatenmasken.
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.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

DataMaskingFunction

Enumeration

Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird.

Wert	Beschreibung
CCN
Default
Email
Number
SSN
Text

DataMaskingPolicyName

Enumeration

Der Name der Datenbank, für die die Datenformatierungsregel gilt.

Wert	Beschreibung
Default

DataMaskingRule

Objekt

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	DataMaskingFunction	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	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.
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.

DataMaskingRuleListResult

Objekt

Die Liste der Regeln für datenbankdatenmasken.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Seite mit Ergebnissen.
value	DataMaskingRule[]	Array von Ergebnissen.

DataMaskingRuleState

Enumeration

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
Disabled
Enabled

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Freigeben über

Data Masking Rules - List By Database

URI-Parameter

Antworten

Beispiele

Gets a list of database data masking rules.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Zusätzliche Ressourcen