Data Masking Rules - List By Database

Tjänst:

SQL Database

API-version:

2023-08-01

Hämtar en lista över regler för databasdatamaskering.

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-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Namnet på databasen som datamaskeringsregeln gäller för.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK	DataMaskingRuleListResult	Listan över serverns Advanced Threat Protection-tillstånd har hämtats.
Other Status Codes	ErrorResponse	Felsvar: ***

Exempel

Gets a list of database data masking rules.

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
DataMaskingFunction	Maskeringsfunktionen som används för datamaskeringsregeln.
DataMaskingPolicyName	Namnet på databasen som datamaskeringsregeln gäller för.
DataMaskingRule	En databasdatamaskeringsregel.
DataMaskingRuleListResult	Listan över regler för datamaskering i databasen.
DataMaskingRuleState	Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

DataMaskingFunction

Uppräkning

Maskeringsfunktionen som används för datamaskeringsregeln.

Värde	Description
CCN
Default
Email
Number
SSN
Text

DataMaskingPolicyName

Uppräkning

Namnet på databasen som datamaskeringsregeln gäller för.

Värde	Description
Default

DataMaskingRule

Objekt

En databasdatamaskeringsregel.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typen av datamaskeringsregel. Metadata som används för Azure-portalen.
location	string	Platsen för datamaskeringsregeln.
name	string	Resursnamn.
properties.aliasName	string	Aliasnamnet. Det här är en äldre parameter och används inte längre.
properties.columnName	string	Kolumnnamnet som datamaskningsregeln tillämpas på.
properties.id	string	Regel-ID:t.
properties.maskingFunction	DataMaskingFunction	Maskeringsfunktionen som används för datamaskeringsregeln.
properties.numberFrom	string	Egenskapen numberFrom för maskeringsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.numberTo	string	Egenskapen numberTo för datamaskningsregeln. Krävs om maskingFunction är inställt på Tal, annars ignoreras den här parametern.
properties.prefixSize	string	Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i början av strängen. Annars ignoreras den här parametern.
properties.replacementString	string	Om maskingFunction är inställt på Text, tecknet som ska användas för maskering av den oexponerade delen av strängen. Annars ignoreras den här parametern.
properties.ruleState	DataMaskingRuleState	Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.
properties.schemaName	string	Schemanamnet som datamaskeringsregeln tillämpas på.
properties.suffixSize	string	Om maskingFunction är inställt på Text visas antalet tecken som ska avmaskeras i slutet av strängen. Annars ignoreras den här parametern.
properties.tableName	string	Tabellnamnet som datamaskeringsregeln tillämpas på.
type	string	Resurstyp.

DataMaskingRuleListResult

Objekt

Listan över regler för datamaskering i databasen.

Name	Typ	Description
nextLink	string	Länka för att hämta nästa sida med resultat.
value	DataMaskingRule[]	Matris med resultat.

DataMaskingRuleState

Uppräkning

Regeltillståndet. Används för att ta bort en regel. Om du vill ta bort en befintlig regel anger du schemaName, tableName, columnName, maskingFunction och anger ruleState som inaktiverat. Men om regeln inte redan finns skapas regeln med ruleState inställd på aktiverad, oavsett det angivna värdet för ruleState.

Värde	Description
Disabled
Enabled

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.