Entity.SetLabelsByUniqueAttribute Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Overloads

SetLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all 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: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler SetLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken) convenience overload with strongly typed models first.

SetLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken)

Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all 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: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

SetLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)

Source:

Entity.cs

[Protocol Method] Set labels to a given entity identified by its type and unique attributes.

If labels is null/empty, existing labels will all 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: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler SetLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken) convenience overload with strongly typed models first.

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

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

Public Overridable Function SetLabelsByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute 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.

attribute

String

The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

typeName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call SetLabelsByUniqueAttribute.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

using RequestContent content = null;
Response response = client.SetLabelsByUniqueAttribute("<typeName>", content);

Console.WriteLine(response.Status);

This sample shows how to call SetLabelsByUniqueAttribute with all parameters and request content.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

using RequestContent content = RequestContent.Create(new object[]
{
    "<body>"
});
Response response = client.SetLabelsByUniqueAttribute("<typeName>", content, attribute: "<attribute>");

Console.WriteLine(response.Status);

SetLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken)

Source:

Entity.cs

Set labels to a given entity identified by its type and unique attributes.

If labels is null/empty, existing labels will all 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: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

public virtual Azure.Response SetLabelsByUniqueAttribute (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SetLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response
override this.SetLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function SetLabelsByUniqueAttribute (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

typeName

String

The name of the type.

body

IEnumerable<String>

set of labels to be set.

attribute

String

The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

typeName is null.

ArgumentException

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

Examples

This sample shows how to call SetLabelsByUniqueAttribute.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

Response response = client.SetLabelsByUniqueAttribute("<typeName>");

This sample shows how to call SetLabelsByUniqueAttribute with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

Response response = client.SetLabelsByUniqueAttribute("<typeName>", body: new string[] { "<body>" }, attribute: "<attribute>");