Data Masking Rules - List By Database

Szolgáltatás:: SQL Database

API-verzió:: 2025-01-01

Megkap egy listát az adatbázis adatmaszkoló szabályairól.

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-paraméterek

Name	In	Kötelező	Típus	Description
databaseName	path	True	string	Az adatbázis neve.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Az adatbázis neve, amelyre az adatmaszkolási szabályzat érvényes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	DataMaskingRuleListResult	Az Azure működése sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Gets a list of database data masking rules.

Mintakérelem

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python data_masking_rule_list_by_database.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.data_masking_rules.list_by_database(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/DataMaskingRuleListByDatabase.json
if __name__ == "__main__":
    main()

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

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

Mintaválasz

Állapotkó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"
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
DataMaskingFunction	Az adatmaszkolási szabályhoz használt maszkoló függvény.
DataMaskingPolicyName	Az adatbázis neve, amelyre az adatmaszkolási szabályzat érvényes.
DataMaskingRule	Egy adatbázis-adatmaszkolási szabály.
DataMaskingRuleListResult	A DataMaskingRule list művelet válasza.
DataMaskingRuleState	A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Felsorolás

Az adatmaszkolási szabályhoz használt maszkoló függvény.

Érték	Description
Default	Alapértelmezett
CCN	CCN
Email	Email
Number	Szám
SSN	TAJ szám
Text	Szöveg

DataMaskingPolicyName

Felsorolás

Az adatbázis neve, amelyre az adatmaszkolási szabályzat érvényes.

Érték	Description
Default	Alapértelmezett

DataMaskingRule

Tárgy

Egy adatbázis-adatmaszkolási szabály.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Az a fajta adatmaszkolási szabály. Metaadat, amelyet az Azure portálhoz használnak.
location	string	Az adatmaszkolási szabály helye.
name	string	Az erőforrás neve
properties.aliasName	string	Az alias neve. Ez egy örökölt paraméter, és már nincs használatban.
properties.columnName	string	Az az oszlopnév, amelyre az adatmaszkoló szabályt alkalmazza.
properties.id	string	A szabály Id.
properties.maskingFunction	DataMaskingFunction	Az adatmaszkolási szabályhoz használt maszkoló függvény.
properties.numberFrom	string	A maszkoló szabály NumberFrom tulajdonsága. Akkor szükséges, ha a MaskingFunction értéke Szám, ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.numberTo	string	Az adatmaszkolási szabály NumberTo tulajdonsága. Akkor szükséges, ha a MaskingFunction értéke Szám, ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.prefixSize	string	Ha a MaskingFunction értéke Szöveg, a sztring elején elrejtett karakterek száma. Ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.replacementString	string	Ha a MaskingFunction szövegre van állítva, a sztring nem használt részének maszkolásához használandó karakter. Ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.ruleState	DataMaskingRuleState	A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.
properties.schemaName	string	Az a sémanév, amelyre az adatmaszkolási szabályt alkalmazza.
properties.suffixSize	string	Ha a MaskingFunction értéke Szöveg, a sztring végén maszkolatlan karakterek száma. Ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.tableName	string	Az a táblanév, amelyre az adatmaszkoló szabályt alkalmazza.
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

DataMaskingRuleListResult

Tárgy

A DataMaskingRule list művelet válasza.

Name	Típus	Description
nextLink	string (uri)	A következő oldalra mutató link
value	DataMaskingRule[]	Az DataMaskingRule elemei ezen az oldalon

DataMaskingRuleState

Felsorolás

A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.

Érték	Description
Enabled	Engedélyezett
Disabled	Disabled

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.