Data Masking Rules - List By Database

Service:: SQL Database

API-versie:: 2023-08-01

Hiermee haalt u een lijst met regels voor databasegegevensmaskering op.

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

Name	In	Vereist	Type	Description
databaseName	path	True	string	De naam van de database.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	De naam van de database waarvoor de gegevensmaskeringsregel van toepassing is.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	DataMaskingRuleListResult	De lijst met Advanced Threat Protection-statussen van de server is opgehaald.
Other Status Codes	ErrorResponse	Foutreacties: ***

Voorbeelden

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=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DataMaskingRuleListByDatabase.json
// this example is just showing the usage of "DataMaskingRules_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataMaskingPolicyResource created on azure
// for more information of creating DataMaskingPolicyResource, please refer to the document of DataMaskingPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6852";
string serverName = "sqlcrudtest-2080";
string databaseName = "sqlcrudtest-331";
DataMaskingPolicyName dataMaskingPolicyName = DataMaskingPolicyName.Default;
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName);
DataMaskingPolicyResource dataMaskingPolicy = client.GetDataMaskingPolicyResource(dataMaskingPolicyResourceId);

// invoke the operation and iterate over the result
await foreach (DataMaskingRule item in dataMaskingPolicy.GetDataMaskingRulesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Voorbeeldrespons

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

Definities

Name	Description
DataMaskingFunction	De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.
DataMaskingPolicyName	De naam van de database waarvoor de gegevensmaskeringsregel van toepassing is.
DataMaskingRule	Een regel voor het maskeren van databasegegevens.
DataMaskingRuleListResult	De lijst met regels voor databasegegevensmaskering.
DataMaskingRuleState	De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

DataMaskingFunction

Inventarisatie

De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.

Waarde	Description
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

Inventarisatie

De naam van de database waarvoor de gegevensmaskeringsregel van toepassing is.

Waarde	Description
Default

DataMaskingRule

Object

Een regel voor het maskeren van databasegegevens.

Name	Type	Description
id	string	Resource-id.
kind	string	Het soort gegevensmaskeringsregel. Metagegevens, die worden gebruikt voor Azure Portal.
location	string	De locatie van de regel voor gegevensmaskering.
name	string	Resourcenaam.
properties.aliasName	string	De aliasnaam. Dit is een verouderde parameter en wordt niet meer gebruikt.
properties.columnName	string	De kolomnaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.id	string	De regel-id.
properties.maskingFunction	DataMaskingFunction	De maskeringsfunctie die wordt gebruikt voor de regel voor gegevensmaskering.
properties.numberFrom	string	De eigenschap numberFrom van de maskeringsregel. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.numberTo	string	De eigenschap NumberTo van de regel voor gegevensmaskering. Vereist als maskingFunction is ingesteld op Getal, anders wordt deze parameter genegeerd.
properties.prefixSize	string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat niet wordt gemaskeerd aan het begin van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.replacementString	string	Als maskingFunction is ingesteld op Tekst, moet het teken worden gebruikt voor het maskeren van het niet-belichte deel van de tekenreeks. Anders wordt deze parameter genegeerd.
properties.ruleState	DataMaskingRuleState	De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.
properties.schemaName	string	De schemanaam waarop de gegevensmaskeringsregel wordt toegepast.
properties.suffixSize	string	Als maskingFunction is ingesteld op Tekst, wordt het aantal tekens weergegeven dat aan het einde van de tekenreeks niet wordt gemaskeerd. Anders wordt deze parameter genegeerd.
properties.tableName	string	De tabelnaam waarop de gegevensmaskeringsregel wordt toegepast.
type	string	Resourcetype.

DataMaskingRuleListResult

Object

De lijst met regels voor databasegegevensmaskering.

Name	Type	Description
nextLink	string	Koppeling om de volgende pagina met resultaten op te halen.
value	DataMaskingRule[]	Matrix met resultaten.

DataMaskingRuleState

Inventarisatie

De regelstatus. Wordt gebruikt om een regel te verwijderen. Als u een bestaande regel wilt verwijderen, geeft u de schemaName, tableName, columnName, maskingFunction op en geeft u ruleState op als uitgeschakeld. Als de regel echter nog niet bestaat, wordt de regel gemaakt met ruleState ingesteld op ingeschakeld, ongeacht de opgegeven waarde van ruleState.

Waarde	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Delen via

Data Masking Rules - List By Database

URI-parameters

Antwoorden

Voorbeelden

Gets a list of database data masking rules.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse