Entity.AddClassifications Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

AddClassifications(String, RequestContent, RequestContext)	[Protocol Method] Add classifications to an existing entity represented by a GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AddClassifications(String, IEnumerable<AtlasClassification>, CancellationToken) convenience overload with strongly typed models first.
AddClassifications(String, IEnumerable<AtlasClassification>, CancellationToken)	Add classifications to an existing entity represented by a GUID.

AddClassifications(String, RequestContent, RequestContext)

Source:

Entity.cs

[Protocol Method] Add classifications to an existing entity represented by a GUID.

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

public virtual Azure.Response AddClassifications (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);

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

Public Overridable Function AddClassifications (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 or content 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 AddClassifications.

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[]
{
    new object()
});
Response response = client.AddClassifications("<guid>", content);

Console.WriteLine(response.Status);

This sample shows how to call AddClassifications 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[]
{
    new
    {
        attributes = new
        {
            key = new object(),
        },
        typeName = "<typeName>",
        lastModifiedTS = "<lastModifiedTS>",
        entityGuid = "<entityGuid>",
        entityStatus = "ACTIVE",
        removePropagationsOnEntityDelete = true,
        validityPeriods = new object[]
        {
            new
            {
                endTime = "<endTime>",
                startTime = "<startTime>",
                timeZone = "<timeZone>",
            }
        },
    }
});
Response response = client.AddClassifications("<guid>", content);

Console.WriteLine(response.Status);

AddClassifications(String, IEnumerable<AtlasClassification>, CancellationToken)

Source:

Entity.cs

Add classifications to an existing entity represented by a GUID.

public virtual Azure.Response AddClassifications (string guid, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, System.Threading.CancellationToken cancellationToken = default);

abstract member AddClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response
override this.AddClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function AddClassifications (guid As String, body As IEnumerable(Of AtlasClassification), Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

guid

String

The globally unique identifier of the entity.

body

IEnumerable<AtlasClassification>

An array of classifications to be added.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

guid or body is null.

ArgumentException

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

Examples

This sample shows how to call AddClassifications.

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

Response response = client.AddClassifications("<guid>", new AtlasClassification[]
{
    new AtlasClassification()
});

This sample shows how to call AddClassifications 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.AddClassifications("<guid>", new AtlasClassification[]
{
    new AtlasClassification
    {
        Attributes =
        {
            ["key"] = BinaryData.FromObjectAsJson(new object())
        },
        TypeName = "<typeName>",
        LastModifiedTS = "<lastModifiedTS>",
        EntityGuid = "<entityGuid>",
        EntityStatus = EntityStatus.Active,
        RemovePropagationsOnEntityDelete = true,
        ValidityPeriods = {new TimeBoundary
        {
            EndTime = "<endTime>",
            StartTime = "<startTime>",
            TimeZone = "<timeZone>",
        }},
    }
});