Data Masking Rules - List By Database

Služba:: SQL Database

Verze rozhraní API:: 2025-01-01

Získá seznam pravidel pro maskování databázových dat.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Název databáze, na kterou se politika maskování dat vztahuje.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DataMaskingRuleListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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=2025-01-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/SQL/stable/2025-01-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://learn.microsoft.com/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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DataMaskingFunction	Funkce maskování, která se používá pro pravidlo maskování dat.
DataMaskingPolicyName
DataMaskingRule	Pravidlo pro maskování dat v databázi.
DataMaskingRuleListResult	Odpověď operace DataMaskingRule list.
DataMaskingRuleState	Stav pravidla. Slouží k odstranění pravidla. Pokud chcete odstranit existující pravidlo, zadejte schemaName, tableName, columnName, maskingFunction a zadejte ruleState jako zakázané. Pokud však pravidlo ještě neexistuje, pravidlo se vytvoří s povolenou hodnotou ruleState bez ohledu na zadanou hodnotu ruleState.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Výčet

Funkce maskování, která se používá pro pravidlo maskování dat.

Hodnota	Description
Default	Výchozí
CCN	CCN
Email	Email
Number	Number
SSN	ČSP
Text	Text

DataMaskingPolicyName

Výčet

Hodnota	Description
Default	Výchozí

DataMaskingRule

Objekt

Pravidlo pro maskování dat v databázi.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Takové pravidlo pro maskování dat. Metadata, použité pro Azure portal.
location	string	Umístění pravidla pro maskování dat.
name	string	Název prostředku
properties.aliasName	string	Název aliasu. Jedná se o starší parametr a už se nepoužívá.
properties.columnName	string	Název sloupce, na kterém se použije pravidlo maskování dat.
properties.id	string	Pravidlo Id.
properties.maskingFunction	DataMaskingFunction	Funkce maskování, která se používá pro pravidlo maskování dat.
properties.numberFrom	string	NumberFrom vlastnost masking rule. Vyžaduje se, pokud je maskingFunction nastaven na Number, jinak bude tento parametr ignorován.
properties.numberTo	string	Vlastnost numberTo pravidla maskování dat. Vyžaduje se, pokud je maskingFunction nastaven na Number, jinak bude tento parametr ignorován.
properties.prefixSize	string	Pokud je maskováníFunction nastaveno na Text, počet znaků, které se mají zobrazit na začátku řetězce. Jinak se tento parametr bude ignorovat.
properties.replacementString	string	Pokud je maskováníFunction nastaveno na Text, znak, který se má použít k maskování nevyexponované části řetězce. Jinak se tento parametr bude ignorovat.
properties.ruleState	DataMaskingRuleState	Stav pravidla. Slouží k odstranění pravidla. Pokud chcete odstranit existující pravidlo, zadejte schemaName, tableName, columnName, maskingFunction a zadejte ruleState jako zakázané. Pokud však pravidlo ještě neexistuje, pravidlo se vytvoří s povolenou hodnotou ruleState bez ohledu na zadanou hodnotu ruleState.
properties.schemaName	string	Název schématu, na kterém je použito pravidlo maskování dat.
properties.suffixSize	string	Pokud je maskingFunction nastaven na Text, počet znaků, které se mají zobrazit odmaskované na konci řetězce. Jinak se tento parametr bude ignorovat.
properties.tableName	string	Název tabulky, na kterém je použito pravidlo maskování dat.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například "Microsoft. Compute/virtualMachines" nebo "Microsoft. Úložiště/úložištěÚčty"

DataMaskingRuleListResult

Objekt

Odpověď operace DataMaskingRule list.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	DataMaskingRule[]	Položky DataMaskingRule na této stránce

DataMaskingRuleState

Výčet

Stav pravidla. Slouží k odstranění pravidla. Pokud chcete odstranit existující pravidlo, zadejte schemaName, tableName, columnName, maskingFunction a zadejte ruleState jako zakázané. Pokud však pravidlo ještě neexistuje, pravidlo se vytvoří s povolenou hodnotou ruleState bez ohledu na zadanou hodnotu ruleState.

Hodnota	Description
Enabled	Enabled
Disabled	Disabled

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.