Classification Rules - Get

Layanan:

Purview

Versi API:

2023-09-01

Mendapatkan aturan klasifikasi.

GET {endpoint}/scan/classificationrules/{classificationRuleName}?api-version=2023-09-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nama aturan klasifikasi.
endpoint	path	True	string (url)	Titik akhir pemindaian akun purview Anda. Contoh: https://{accountName}.purview.azure.com.
api-version	query	True	string	Versi api yang akan digunakan.

Respons

Nama	Jenis	Deskripsi
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Keberhasilan.
Other Status Codes	ErrorResponseModel	Respons kesalahan diterima dari Layanan Pemindaian. Header x-ms-error-code: string

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

ClassificationRules_Get

Permintaan sampel

HTTP

GET {endpoint}/scan/classificationrules/ClassificationRule1?api-version=2023-09-01

Respon sampel

Kode status:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1",
  "name": "ClassificationRule1",
  "kind": "Custom",
  "properties": {
    "minimumPercentageMatch": 80,
    "classificationAction": "Keep",
    "description": "second one",
    "version": 4,
    "classificationName": "CUSTOM.TEST.TWO",
    "ruleStatus": "Enabled",
    "createdAt": "2019-12-09T06:43:30.8478469Z",
    "lastModifiedAt": "2019-12-09T07:04:53.2807344Z",
    "dataPatterns": [
      {
        "kind": "Regex",
        "pattern": "^data1$"
      },
      {
        "kind": "Regex",
        "pattern": "^data2$"
      }
    ],
    "columnPatterns": [
      {
        "kind": "Regex",
        "pattern": "^column1$"
      }
    ]
  }
}

Definisi

Nama	Deskripsi
ClassificationAction	Tindakan aturan klasifikasi.
ClassificationRuleStatus	Status aturan aturan klasifikasi sistem.
CustomClassificationRule	Aturan klasifikasi kustom.
CustomClassificationRuleProperties	Properti aturan klasifikasi kustom.
ErrorModel	Model kesalahan.
ErrorResponseModel	Model respons kesalahan.
RegexClassificationRulePattern	Pola aturan klasifikasi regex.
SystemClassificationRule	Aturan klasifikasi sistem.
SystemClassificationRuleProperties	Properti aturan klasifikasi sistem.

ClassificationAction

Enumeration

Tindakan aturan klasifikasi.

Nilai	Deskripsi
Keep
Delete

ClassificationRuleStatus

Enumeration

Status aturan aturan klasifikasi sistem.

Nilai	Deskripsi
Enabled
Disabled

CustomClassificationRule

Objek

Aturan klasifikasi kustom.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.
kind	string: Custom	Jenis aturan klasifikasi.
name	string	Nama sumber daya.
properties	CustomClassificationRuleProperties	Properti aturan klasifikasi kustom.

CustomClassificationRuleProperties

Objek

Properti aturan klasifikasi kustom.

Nama	Jenis	Deskripsi
classificationAction	ClassificationAction	Tindakan aturan klasifikasi.
classificationName	string	Nama klasifikasi aturan klasifikasi kustom.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Pola kolom aturan klasifikasi kustom.
createdAt	string (date-time)	Waktu pembuatan aturan klasifikasi kustom.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Pola data aturan klasifikasi kustom.
description	string	Deskripsi aturan klasifikasi kustom.
lastModifiedAt	string (date-time)	Waktu terakhir yang dimodifikasi dari aturan klasifikasi kustom.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	Status aturan aturan klasifikasi kustom.
version	integer (int32)	Versi aturan klasifikasi kustom.

ErrorModel

Objek

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan unik yang mengidentifikasi kesalahan tertentu.
details	ErrorModel[]	Array objek ErrorModel berlapis yang menyediakan detail kesalahan tambahan.
message	string	Pesan kesalahan yang dapat dibaca manusia yang memberikan detail selengkapnya tentang kesalahan tersebut.
target	string	Komponen spesifik yang dikaitkan dengan kesalahan.

ErrorResponseModel

Objek

Model respons kesalahan.

Nama	Jenis	Deskripsi
error	ErrorModel	Model kesalahan.

RegexClassificationRulePattern

Objek

Pola aturan klasifikasi regex.

Nama	Jenis	Deskripsi
kind	string: Regex	Properti pola aturan klasifikasi.
pattern	string	Pola pola aturan klasifikasi regex.

SystemClassificationRule

Objek

Aturan klasifikasi sistem.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya.
kind	string: System	Jenis aturan klasifikasi.
name	string	Nama sumber daya.
properties	SystemClassificationRuleProperties	Properti aturan klasifikasi sistem.

SystemClassificationRuleProperties

Objek

Properti aturan klasifikasi sistem.

Nama	Jenis	Deskripsi
classificationName	string	Nama klasifikasi aturan klasifikasi sistem.
createdAt	string (date-time)	Waktu pembuatan aturan klasifikasi sistem.
description	string
lastModifiedAt	string (date-time)	Waktu terakhir yang dimodifikasi dari aturan klasifikasi sistem.
ruleStatus	ClassificationRuleStatus	Status aturan aturan klasifikasi sistem.
version	integer (int32)	Versi aturan klasifikasi sistem.