Share via

Entity.AddLabel Method

  • Reference

Definition

Namespace:
Azure.Analytics.Purview.DataMap
Assembly:
Azure.Analytics.Purview.DataMap.dll
Package:
Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Overloads

AddLabel(String, RequestContent, RequestContext)

[Protocol Method] Add given labels to a given entity.
AddLabel(String, IEnumerable<String>, CancellationToken)

Add given labels to a given entity.

AddLabel(String, RequestContent, RequestContext)

Source:
Entity.cs

[Protocol Method] Add given labels to a given entity.

public virtual Azure.Response AddLabel (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member AddLabel : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddLabel : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function AddLabel (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

guid
String

The globally unique identifier of the entity.

content
RequestContent

The content to send as the body of the request.

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

guid is null.

ArgumentException

guid 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 AddLabel.

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.AddLabel("<guid>", content);

Console.WriteLine(response.Status);

This sample shows how to call AddLabel 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.AddLabel("<guid>", content);

Console.WriteLine(response.Status);

Applies to

AddLabel(String, IEnumerable<String>, CancellationToken)

Source:
Entity.cs

Add given labels to a given entity.

public virtual Azure.Response AddLabel (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AddLabel : string * seq<string> * System.Threading.CancellationToken -> Azure.Response
override this.AddLabel : string * seq<string> * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function AddLabel (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

guid
String

The globally unique identifier of the entity.

body
IEnumerable<String>

set of labels to be added.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

guid is null.

ArgumentException

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

Examples

This sample shows how to call AddLabel.

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

Response response = client.AddLabel("<guid>");

This sample shows how to call AddLabel 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.AddLabel("<guid>", body: new string[] { "<body>" });

Applies to