Entity.UpdateClassificationsAsync Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

UpdateClassificationsAsync(String, RequestContent, RequestContext)	[Protocol Method] Update 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 UpdateClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken) convenience overload with strongly typed models first.
UpdateClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken)	Update classifications to an existing entity represented by a guid.

UpdateClassificationsAsync(String, RequestContent, RequestContext)

Source:

Entity.cs

[Protocol Method] Update 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 UpdateClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> UpdateClassificationsAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member UpdateClassificationsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateClassificationsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function UpdateClassificationsAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of 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

Task<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 UpdateClassificationsAsync.

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 = await client.UpdateClassificationsAsync("<guid>", content);

Console.WriteLine(response.Status);

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

Console.WriteLine(response.Status);

UpdateClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken)

Source:

Entity.cs

Update classifications to an existing entity represented by a guid.

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

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

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

Parameters

guid

String

The globally unique identifier of the entity.

body

IEnumerable<AtlasClassification>

An array of classifications to be updated.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<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 UpdateClassificationsAsync.

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

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

This sample shows how to call UpdateClassificationsAsync 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 = await client.UpdateClassificationsAsync("<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>",
        }},
    }
});