Share via

Entity.BatchCreateOrUpdateAsync Method

Definition

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

Overloads

Name Description
BatchCreateOrUpdateAsync(AtlasEntitiesWithExtInfo, String, Nullable<BusinessAttributeUpdateBehavior>, CancellationToken)

Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. For each contact type, the maximum number of contacts is 20.
BatchCreateOrUpdateAsync(RequestContent, String, String, RequestContext)

[Protocol Method] Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. For each contact type, the maximum number of contacts is 20.

BatchCreateOrUpdateAsync(AtlasEntitiesWithExtInfo, String, Nullable<BusinessAttributeUpdateBehavior>, CancellationToken)

Source:
Entity.cs

Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. For each contact type, the maximum number of contacts is 20.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> BatchCreateOrUpdateAsync(Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo body, string collectionId = default, Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior? businessAttributeUpdateBehavior = default, System.Threading.CancellationToken cancellationToken = default);
abstract member BatchCreateOrUpdateAsync : Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo * string * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.BatchCreateOrUpdateAsync : Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo * string * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
Public Overridable Function BatchCreateOrUpdateAsync (body As AtlasEntitiesWithExtInfo, Optional collectionId As String = Nothing, Optional businessAttributeUpdateBehavior As Nullable(Of BusinessAttributeUpdateBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))

Parameters

body
AtlasEntitiesWithExtInfo

Body parameter.

collectionId
String

The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

businessAttributeUpdateBehavior
Nullable<BusinessAttributeUpdateBehavior>

Used to define the update behavior for business attributes when updating entities.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<EntityMutationResult>>

Exceptions

ArgumentNullException

body is null.

Examples

This sample shows how to call BatchCreateOrUpdateAsync.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

AtlasEntitiesWithExtInfo body = new AtlasEntitiesWithExtInfo
{
    ReferredEntities = { },
    Entities = {new AtlasEntity
    {
        Attributes =
        {
            ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"),
            ["modifiedTime"] = BinaryData.FromObjectAsJson(0),
            ["createTime"] = BinaryData.FromObjectAsJson(0),
            ["qualifiedName"] = BinaryData.FromObjectAsJson("exampleaccount1"),
            ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount1"),
            ["description"] = null,
            ["publicAccessLevel"] = null
        },
        TypeName = "azure_storage_account",
        CreatedBy = "ExampleCreator",
        Status = EntityStatus.Active,
        UpdatedBy = "ExampleUpdator",
        Version = 0L,
        Contacts =
        {
            ["Expert"] = new ContactInfo[]
            {
                new ContactInfo
                {
                    Id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                    Info = "Example Expert Info",
                }
            },
            ["Owner"] = new ContactInfo[]
            {
                new ContactInfo
                {
                    Id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                    Info = "Example Owner Info",
                }
            }
        },
    }, new AtlasEntity
    {
        Attributes =
        {
            ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"),
            ["modifiedTime"] = BinaryData.FromObjectAsJson(0),
            ["createTime"] = BinaryData.FromObjectAsJson(0),
            ["qualifiedName"] = BinaryData.FromObjectAsJson("exampleaccount2"),
            ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount2"),
            ["description"] = BinaryData.FromObjectAsJson("Example Description"),
            ["publicAccessLevel"] = null
        },
        TypeName = "azure_storage_account",
        CreatedBy = "ExampleCreator",
        Status = EntityStatus.Active,
        UpdatedBy = "ExampleUpdator",
        Version = 0L,
        Contacts =
        {
            ["Expert"] = new ContactInfo[]
            {
                new ContactInfo
                {
                    Id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                    Info = "Example Expert Info",
                }
            },
            ["Owner"] = new ContactInfo[]
            {
                new ContactInfo
                {
                    Id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                    Info = "Example Owner Info",
                }
            }
        },
    }},
};
Response<EntityMutationResult> response = await client.BatchCreateOrUpdateAsync(body);

Applies to

BatchCreateOrUpdateAsync(RequestContent, String, String, RequestContext)

Source:
Entity.cs

[Protocol Method] Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. For each contact type, the maximum number of contacts is 20.

public virtual System.Threading.Tasks.Task<Azure.Response> BatchCreateOrUpdateAsync(Azure.Core.RequestContent content, string collectionId = default, string businessAttributeUpdateBehavior = default, Azure.RequestContext context = default);
abstract member BatchCreateOrUpdateAsync : Azure.Core.RequestContent * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.BatchCreateOrUpdateAsync : Azure.Core.RequestContent * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function BatchCreateOrUpdateAsync (content As RequestContent, Optional collectionId As String = Nothing, Optional businessAttributeUpdateBehavior As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

content
RequestContent

The content to send as the body of the request.

collectionId
String

The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

businessAttributeUpdateBehavior
String

Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore" | "replace" | "merge"

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

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call BatchCreateOrUpdateAsync and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Entity client = new DataMapClient(endpoint, credential).GetEntityClient();

using RequestContent content = RequestContent.Create(new
{
    referredEntities = new object(),
    entities = new object[]
    {
        new
        {
            typeName = "azure_storage_account",
            attributes = new
            {
                owner = "ExampleOwner",
                modifiedTime = 0,
                createTime = 0,
                qualifiedName = "exampleaccount1",
                name = "ExampleStorageAccount1",
            },
            contacts = new
            {
                Expert = new object[]
                {
                    new
                    {
                        id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                        info = "Example Expert Info",
                    }
                },
                Owner = new object[]
                {
                    new
                    {
                        id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                        info = "Example Owner Info",
                    }
                },
            },
            status = "ACTIVE",
            createdBy = "ExampleCreator",
            updatedBy = "ExampleUpdator",
            version = 0L,
        },
        new
        {
            typeName = "azure_storage_account",
            attributes = new
            {
                owner = "ExampleOwner",
                modifiedTime = 0,
                createTime = 0,
                qualifiedName = "exampleaccount2",
                name = "ExampleStorageAccount2",
                description = "Example Description",
            },
            contacts = new
            {
                Expert = new object[]
                {
                    new
                    {
                        id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                        info = "Example Expert Info",
                    }
                },
                Owner = new object[]
                {
                    new
                    {
                        id = "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
                        info = "Example Owner Info",
                    }
                },
            },
            status = "ACTIVE",
            createdBy = "ExampleCreator",
            updatedBy = "ExampleUpdator",
            version = 0L,
        }
    },
});
Response response = await client.BatchCreateOrUpdateAsync(content);

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

Applies to