Skip to content

pvw glossary read

Command Reference > glossary > read

Description

Retrieve glossary term or category.

Syntax

pvw glossary read [--glossaryGuid=<val> --limit=<val> --offset=<val> --sort=<val> --ignoreTermsAndCategories]

Required Arguments

  • --glossaryGuid: glossaryGuid parameter
  • --limit: limit parameter
  • --offset: offset parameter
  • --sort: sort parameter

Optional Arguments

  • --purviewName: Microsoft Purview account name. (string)
  • --categoryGuid: The globally unique identifier of the category. (string)
  • --glossaryName: The name of the glossary. (string)
  • --operationGuid: The globally unique identifier for async operation/job. (string)
  • --payloadFile: File path to a valid JSON document. (string)
  • --termGuid: The globally unique identifier for glossary term. (string)

API Mapping

Catalog Data Plane > Glossary > Read 

 https://{accountName}.purview.azure.com/catalog/api/atlas/v2/glossary/read

Examples

DESCRIBE_EXAMPLE. 

EXAMPLE_COMMAND

Example payload. 

PASTE_JSON_HERE