Glossary.CreateCategory Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

CreateCategory(AtlasGlossaryCategory, CancellationToken)	Create a glossary category.
CreateCategory(RequestContent, RequestContext)	[Protocol Method] Create a glossary category. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateCategory(AtlasGlossaryCategory, CancellationToken) convenience overload with strongly typed models first.

CreateCategory(AtlasGlossaryCategory, CancellationToken)

Source:

Glossary.cs

Create a glossary category.

public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory> CreateCategory (Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory atlasGlossaryCategory, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateCategory : Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>
override this.CreateCategory : Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>

Public Overridable Function CreateCategory (atlasGlossaryCategory As AtlasGlossaryCategory, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasGlossaryCategory)

Parameters

atlasGlossaryCategory

AtlasGlossaryCategory

The glossary category.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AtlasGlossaryCategory>

Exceptions

ArgumentNullException

atlasGlossaryCategory is null.

Examples

This sample shows how to call CreateCategory.

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 = client.CreateCategory(atlasGlossaryCategory);

This sample shows how to call CreateCategory 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 = client.CreateCategory(atlasGlossaryCategory);

CreateCategory(RequestContent, RequestContext)

Source:

Glossary.cs

[Protocol Method] Create a glossary category.

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

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

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

Public Overridable Function CreateCategory (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

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

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CreateCategory 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 = client.CreateCategory(content);

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

This sample shows how to call CreateCategory with all 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 = client.CreateCategory(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());