Glossary.UpdateCategoryAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.DataMap

Assembly:: Azure.Analytics.Purview.DataMap.dll

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

UpdateCategoryAsync(String, AtlasGlossaryCategory, CancellationToken)

Update the given glossary category by its GUID.

UpdateCategoryAsync(String, RequestContent, RequestContext)

[Protocol Method] Update the given glossary category by its GUID.

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

UpdateCategoryAsync(String, AtlasGlossaryCategory, CancellationToken)

Source:: Glossary.cs

Update the given glossary category by its GUID.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>> UpdateCategoryAsync (string categoryId, Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory atlasGlossaryCategory, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function UpdateCategoryAsync (categoryId As String, atlasGlossaryCategory As AtlasGlossaryCategory, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasGlossaryCategory))

Parameters

categoryId: String

The globally unique identifier of the category.

atlasGlossaryCategory: AtlasGlossaryCategory

The glossary category.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<AtlasGlossaryCategory>>

Exceptions

ArgumentNullException

categoryId or atlasGlossaryCategory is null.

ArgumentException

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

Examples

This sample shows how to call UpdateCategoryAsync.

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

AtlasGlossaryCategory atlasGlossaryCategory = new AtlasGlossaryCategory();
Response<AtlasGlossaryCategory> response = await client.UpdateCategoryAsync("<categoryId>", atlasGlossaryCategory);

This sample shows how to call UpdateCategoryAsync with all parameters.

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

AtlasGlossaryCategory atlasGlossaryCategory = new AtlasGlossaryCategory
{
    Guid = "<guid>",
    Classifications = {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>",
        }},
    }},
    LongDescription = "<longDescription>",
    Name = "<name>",
    QualifiedName = "<qualifiedName>",
    ShortDescription = "<shortDescription>",
    LastModifiedTS = "<lastModifiedTS>",
    CreateTime = 1234L,
    CreatedBy = "<createdBy>",
    UpdateTime = 1234L,
    UpdatedBy = "<updatedBy>",
    Anchor = new AtlasGlossaryHeader
    {
        DisplayText = "<displayText>",
        GlossaryGuid = "<glossaryGuid>",
        RelationGuid = "<relationGuid>",
    },
    ChildrenCategories = {new AtlasRelatedCategoryHeader
    {
        CategoryGuid = "<categoryGuid>",
        Description = "<description>",
        DisplayText = "<displayText>",
        ParentCategoryGuid = "<parentCategoryGuid>",
        RelationGuid = "<relationGuid>",
    }},
    ParentCategory = default,
    Terms = {new AtlasRelatedTermHeader
    {
        Description = "<description>",
        DisplayText = "<displayText>",
        Expression = "<expression>",
        RelationGuid = "<relationGuid>",
        Status = AtlasTermRelationshipStatus.Draft,
        Steward = "<steward>",
        TermGuid = "<termGuid>",
    }},
};
Response<AtlasGlossaryCategory> response = await client.UpdateCategoryAsync("<categoryId>", atlasGlossaryCategory);

Applies to

UpdateCategoryAsync(String, RequestContent, RequestContext)

Source:: Glossary.cs

[Protocol Method] Update the given glossary category by its GUID.

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

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

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

Public Overridable Function UpdateCategoryAsync (categoryId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

categoryId: String

The globally unique identifier of the category.

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

categoryId or content is null.

ArgumentException

categoryId 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 UpdateCategoryAsync and parse the result.

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

using RequestContent content = RequestContent.Create(new object());
Response response = await client.UpdateCategoryAsync("<categoryId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

This sample shows how to call UpdateCategoryAsync with all parameters and request content and parse the result.

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

using RequestContent content = RequestContent.Create(new
{
    guid = "<guid>",
    classifications = 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>",
                }
            },
        }
    },
    longDescription = "<longDescription>",
    name = "<name>",
    qualifiedName = "<qualifiedName>",
    shortDescription = "<shortDescription>",
    lastModifiedTS = "<lastModifiedTS>",
    createTime = 1234L,
    createdBy = "<createdBy>",
    updateTime = 1234L,
    updatedBy = "<updatedBy>",
    anchor = new
    {
        displayText = "<displayText>",
        glossaryGuid = "<glossaryGuid>",
        relationGuid = "<relationGuid>",
    },
    childrenCategories = new object[]
    {
        new
        {
            categoryGuid = "<categoryGuid>",
            description = "<description>",
            displayText = "<displayText>",
            parentCategoryGuid = "<parentCategoryGuid>",
            relationGuid = "<relationGuid>",
        }
    },
    terms = new object[]
    {
        new
        {
            description = "<description>",
            displayText = "<displayText>",
            expression = "<expression>",
            relationGuid = "<relationGuid>",
            status = "DRAFT",
            steward = "<steward>",
            termGuid = "<termGuid>",
        }
    },
});
Response response = await client.UpdateCategoryAsync("<categoryId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("guid").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString());
Console.WriteLine(result.GetProperty("longDescription").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("qualifiedName").ToString());
Console.WriteLine(result.GetProperty("shortDescription").ToString());
Console.WriteLine(result.GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("createTime").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("updateTime").ToString());
Console.WriteLine(result.GetProperty("updatedBy").ToString());
Console.WriteLine(result.GetProperty("anchor").GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("anchor").GetProperty("glossaryGuid").ToString());
Console.WriteLine(result.GetProperty("anchor").GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString());
Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result.GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("parentCategory").GetProperty("categoryGuid").ToString());
Console.WriteLine(result.GetProperty("parentCategory").GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parentCategory").GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result.GetProperty("parentCategory").GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString());

Applies to

Share via

Glossary.UpdateCategoryAsync Method

Definition

Overloads

UpdateCategoryAsync(String, AtlasGlossaryCategory, CancellationToken)

Parameters

Returns

Exceptions

Examples

Applies to

UpdateCategoryAsync(String, RequestContent, RequestContext)

Parameters

Returns

Exceptions

Examples

Applies to

Additional resources