setLabels.md

pv entity setLabels

Command Reference > entity > setLabels

Description

Overwrite labels for an entity.

Syntax

pv entity setLabels --guid=<val> --payloadFile=<val>

Required Arguments

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

--payloadFile (string)
File path to a valid JSON document.

Optional Arguments

None

API Mapping

Catalog Data Plane > Entity > Set labels to a given entity.

POST https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity/guid/{guid}/labels

Examples

Overwrite labels property for an existing entity.

pv entity setLabels --guid "7738b5c7-7977-4261-9871-7d00e11cabe8" --payloadFile "/path/to/file.json"

Example payload.

[
    "a",
    "b",
    "c"
]