Data Masking Rules - List By Database

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Ruft eine Liste der Datenbankdatenmaskierungsregeln ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules?api-version=2021-11-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 Datenmaskierungsregel gilt.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

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

Beispiele

Gets a list of database data masking rules.

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=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleListByDatabase.json
     */
    /**
     * Sample code: Gets a list of database data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabaseDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDataMaskingRules().listByDatabase("sqlcrudtest-6852",
            "sqlcrudtest-2080", "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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 Datenmaskierungsregel verwendet wird.
DataMaskingPolicyName	Der Name der Datenbank, für die die Datenmaskierungsregel gilt.
DataMaskingRule	Eine Datenbank-Datenmaskierungsregel.
DataMaskingRuleListResult	Die Liste der Regeln für die Datenbankdatenmaskierung.
DataMaskingRuleState	Der Regelzustand. Wird verwendet, um eine Regel zu löschen. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel erstellt, wobei ruleState auf aktiviert festgelegt ist, unabhängig vom bereitgestellten Wert von ruleState.

DataMaskingFunction

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

Name	Typ	Beschreibung
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

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

Name	Typ	Beschreibung
Default	string

DataMaskingRule

Eine Datenbank-Datenmaskierungsregel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
kind	string	Die Art der Datenmaskierungsregel. Metadaten, die für Azure-Portal verwendet werden.
location	string	Der Speicherort der Datenmaskierungsregel.
name	string	Name der Ressource.
properties.aliasName	string	Der Aliasname. Dies ist ein Legacyparameter, der nicht mehr verwendet wird.
properties.columnName	string	Der Spaltenname, auf den die Datenmaskierungsregel angewendet wird.
properties.id	string	Die Regel-ID.
properties.maskingFunction	DataMaskingFunction	Die Maskierungsfunktion, die für die Datenmaskierungsregel verwendet wird.
properties.numberFrom	string	Die numberFrom-Eigenschaft der Maskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.numberTo	string	Die numberTo-Eigenschaft der Datenmaskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.prefixSize	string	Wenn maskingFunction auf Text festgelegt ist, ist die Anzahl der Zeichen, die am Anfang der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.
properties.replacementString	string	Wenn maskingFunction auf Text festgelegt ist, ist das Zeichen, das zum Maskieren des nicht verfügbar gemachten Teils der Zeichenfolge verwendet werden soll. Andernfalls wird dieser Parameter ignoriert.
properties.ruleState	DataMaskingRuleState	Der Regelzustand. Wird verwendet, um eine Regel zu löschen. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel erstellt, wobei ruleState auf aktiviert festgelegt ist, unabhängig vom bereitgestellten Wert von ruleState.
properties.schemaName	string	Der Schemaname, auf den die Datenmaskierungsregel angewendet wird.
properties.suffixSize	string	Wenn maskingFunction auf Text festgelegt ist, gibt die Anzahl der Zeichen an, die am Ende der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.
properties.tableName	string	Der Tabellenname, auf den die Datenmaskierungsregel angewendet wird.
type	string	Der Ressourcentyp.

DataMaskingRuleListResult

Die Liste der Regeln für die Datenbankdatenmaskierung.

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

DataMaskingRuleState

Der Regelzustand. Wird verwendet, um eine Regel zu löschen. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel erstellt, wobei ruleState auf aktiviert festgelegt ist, unabhängig vom bereitgestellten Wert von ruleState.

Name	Typ	Beschreibung
Disabled	string
Enabled	string