Data Masking Rules - List By Database

Layanan:: SQL Database

Versi API:: 2025-01-01

Mendapatkan daftar aturan penyamaran data database.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
databaseName	path	True	string	Nama database.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Nama database tempat kebijakan penyamaran data berlaku.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	DataMaskingRuleListResult	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Respon sampel

Kode status:: 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"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
DataMaskingFunction	Fungsi masking yang digunakan untuk aturan masking data.
DataMaskingPolicyName
DataMaskingRule	Aturan penyamaran data database.
DataMaskingRuleListResult	Respons operasi daftar DataMaskingRule.
DataMaskingRuleState	Status aturan. Digunakan untuk menghapus aturan. Untuk menghapus aturan yang ada, tentukan schemaName, tableName, columnName, maskingFunction, dan tentukan ruleState sebagai dinonaktifkan. Namun, jika aturan belum ada, aturan akan dibuat dengan seperangkat ruleState untuk diaktifkan, terlepas dari nilai ruleState yang disediakan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DataMaskingFunction

Enumerasi

Fungsi masking yang digunakan untuk aturan masking data.

Nilai	Deskripsi
Default	Default
CCN	CCN
Email	Email
Number	Angka
SSN	Nomor Jaminan Sosial
Text	Teks

DataMaskingPolicyName

Enumerasi

Nilai	Deskripsi
Default	Default

DataMaskingRule

Objek

Aturan penyamaran data database.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Jenis Aturan Penyamaran Data. Metadata, digunakan untuk portal Azure.
location	string	Lokasi aturan penyamaran data.
name	string	Nama sumber daya
properties.aliasName	string	Nama alias. Ini adalah parameter warisan dan tidak lagi digunakan.
properties.columnName	string	Nama kolom tempat aturan masking data diterapkan.
properties.id	string	Aturan Id.
properties.maskingFunction	DataMaskingFunction	Fungsi masking yang digunakan untuk aturan masking data.
properties.numberFrom	string	Properti numberFrom dari aturan masking. Diperlukan jika maskingFunction diatur ke Angka, jika tidak, parameter ini akan diabaikan.
properties.numberTo	string	Properti numberTo dari aturan masking data. Diperlukan jika maskingFunction diatur ke Angka, jika tidak, parameter ini akan diabaikan.
properties.prefixSize	string	Jika maskingFunction diatur ke Teks, jumlah karakter untuk ditampilkan tanpa kemasan di awal string. Jika tidak, parameter ini akan diabaikan.
properties.replacementString	string	Jika maskingFunction diatur ke Teks, karakter yang akan digunakan untuk menutupi bagian untai (karakter) yang tidak diekspos. Jika tidak, parameter ini akan diabaikan.
properties.ruleState	DataMaskingRuleState	Status aturan. Digunakan untuk menghapus aturan. Untuk menghapus aturan yang ada, tentukan schemaName, tableName, columnName, maskingFunction, dan tentukan ruleState sebagai dinonaktifkan. Namun, jika aturan belum ada, aturan akan dibuat dengan seperangkat ruleState untuk diaktifkan, terlepas dari nilai ruleState yang disediakan.
properties.schemaName	string	Nama skema tempat aturan masking data diterapkan.
properties.suffixSize	string	Jika maskingFunction diatur ke Teks, jumlah karakter untuk ditampilkan tanpa kemasan di akhir string. Jika tidak, parameter ini akan diabaikan.
properties.tableName	string	Nama tabel tempat aturan masking data diterapkan.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

DataMaskingRuleListResult

Objek

Respons operasi daftar DataMaskingRule.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	DataMaskingRule[]	Item DataMaskingRule di halaman ini

DataMaskingRuleState

Enumerasi

Status aturan. Digunakan untuk menghapus aturan. Untuk menghapus aturan yang ada, tentukan schemaName, tableName, columnName, maskingFunction, dan tentukan ruleState sebagai dinonaktifkan. Namun, jika aturan belum ada, aturan akan dibuat dengan seperangkat ruleState untuk diaktifkan, terlepas dari nilai ruleState yang disediakan.

Nilai	Deskripsi
Enabled	Enabled
Disabled	Nonaktif

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.