readClassificationDef.md

pv types readClassificationDef

Command Reference > types > readClassificationDef

Description

Get the classification definition for the given GUID or by its name (unique).

Syntax

pv types readClassificationDef (--guid=<val> | --name=<val>)

Required Arguments

--guid (string)
The globally unique identifier of the classification.

--name (string)
The name of the classification.

Optional Arguments

None

API Mapping

Catalog Data Plane > Types > Get Classification Def By Guid

GET https://{accountName}.purview.azure.com/catalog/api/atlas/v2/types/classificationdef/guid/{guid}

Catalog Data Plane > Types > Get Classification Def By Name

GET https://{accountName}.purview.azure.com/catalog/api/atlas/v2/types/classificationdef/name/{name}

Examples

Get classification definition by name.

pv types readClassificationDef --name "MICROSOFT.GOVERNMENT.CANADA.DRIVERS_LICENSE_NUMBER"

Sample response.

{
    "attributeDefs": [],
    "category": "CLASSIFICATION",
    "createTime": 1615787943724,
    "createdBy": "admin",
    "description": "Canada Driver's License Number",
    "entityTypes": [],
    "guid": "324fd07d-327a-3c0a-5f74-ee9310936782",
    "name": "MICROSOFT.GOVERNMENT.CANADA.DRIVERS_LICENSE_NUMBER",
    "options": {
        "displayName": "Canada Driver's License Number"
    },
    "subTypes": [],
    "superTypes": [],
    "typeVersion": "1.0",
    "updateTime": 1615787943724,
    "updatedBy": "admin",
    "version": 1
}

Get classification definition by guid.

pv types readClassificationDef --guid "324fd07d-327a-3c0a-5f74-ee9310936782"