Skip to content

pvw types readRelationshipDef

Command Reference > types > readRelationshipDef

Description

Retrieve type definition.

Syntax

pvw types readRelationshipDef (--guid=<val> | --name=<val>)

Required Arguments

  • --guid: guid parameter
  • --name: name parameter

Optional Arguments

  • --purviewName: Microsoft Purview account name. (string)
  • --payloadFile: File path to a valid JSON document. (string)
  • --type: Typedef name as search filter (classification | entity | enum | relationship | struct). (string)

API Mapping

Catalog Data Plane > Types > Readrelationshipdef

 https://{accountName}.purview.azure.com/catalog/api/atlas/v2/types/readRelationshipDef

Examples

DESCRIBE_EXAMPLE.

EXAMPLE_COMMAND

Example payload.

PASTE_JSON_HERE