PurviewEntities.DeleteLabelsByUniqueAttribute Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewEntities.cs

Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

public virtual Azure.Response DeleteLabelsByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attrQualifiedName = default, Azure.RequestContext context = default);

abstract member DeleteLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.DeleteLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteLabelsByUniqueAttribute (typeName As String, content As RequestContent, Optional attrQualifiedName As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

typeName

String

The name of the type.

content

RequestContent

The content to send as the body of the request.

attrQualifiedName

String

The qualified name of the entity.

context

RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Response

Exceptions

ArgumentNullException

typeName is null.

ArgumentException

typeName is an empty string, and was expected to be non-empty.