deleteLabelsByUniqueAttribute.md

pv entity deleteLabelsByUniqueAttribute

Command Reference > entity > deleteLabelsByUniqueAttribute

Description

Delete label(s) from an entity identified by its type and unique attributes.

Syntax

pv entity deleteLabelsByUniqueAttribute --typeName=<val> --qualifiedName=<val> --payloadFile=<val>

Required Arguments

--typeName (string)
The name of the type.

--qualifiedName (string)
The qualified name of the entity.

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

Optional Arguments

None

API Mapping

Catalog Data Plane > Entity > Delete given labels to a given entity identified by its type and unique attributes.

DELETE https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels

Examples

Delete labels from an existing entity identified by its type and unique attributes.

pv entity deleteLabelsByUniqueAttribute --typeName "azure_datalake_gen2_resource_set" --qualifiedName "https://STORAGE_ACCOUNT.dfs.core.windows.net/bing/data/{N}/QueriesByCountry_{Year}-{Month}-{Day}_{N}-{N}-{N}.tsv" --payloadFile "/path/to/file.json"

Example payload.

[
    "a",
    "c"
]