Data Masking Rules - List By Database

Dienst:: SQL Database

API-Version:: 2025-01-01

Erhält eine Liste der Datenbank-Datenmaskierungsregeln.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules?api-version=2025-01-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 Datenmaskierungsrichtlinie gilt.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DataMaskingRuleListResult	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

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=2025-01-01

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataMaskingFunction	Die Maskierungsfunktion, die für die Datenformatierungsregel verwendet wird.
DataMaskingPolicyName
DataMaskingRule	Eine Datenbank-Datenmaskierungsregel.
DataMaskingRuleListResult	Die Antwort einer DataMaskingRule-Listenoperation.
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
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DataMaskingFunction

Enumeration

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

Wert	Beschreibung
Default	Vorgabe
CCN	CCN
Email	E‑Mail
Number	Nummer
SSN	Sozialversicherungsnummer
Text	Text

DataMaskingPolicyName

Enumeration

Wert	Beschreibung
Default	Vorgabe

DataMaskingRule

Objekt

Eine Datenbank-Datenmaskierungsregel.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Die Art von Datenmaskierungsregel. Metadaten, verwendet für Azure Portal.
location	string	Der Standort der Datenmaskierungsregel.
name	string	Der Name der Ressource
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.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

DataMaskingRuleListResult

Objekt

Die Antwort einer DataMaskingRule-Listenoperation.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	DataMaskingRule[]	Die DataMaskingRule-Elemente auf dieser Seite

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

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.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Data Masking Rules - List By Database

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Gets a list of database data masking rules.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData