PurviewEntities.DeleteByGuids Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewEntities.cs

Delete a list of entities in bulk identified by their GUIDs or unique attributes.

public virtual Azure.Response DeleteByGuids (System.Collections.Generic.IEnumerable<string> guids, Azure.RequestContext context = default);

abstract member DeleteByGuids : seq<string> * Azure.RequestContext -> Azure.Response
override this.DeleteByGuids : seq<string> * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteByGuids (guids As IEnumerable(Of String), Optional context As RequestContext = Nothing) As Response

Parameters

guids

IEnumerable<String>

An array of GUIDs of entities to delete.

context

RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Response

Exceptions

ArgumentNullException

guids is null.

Remarks

Schema for Response Body:

{
              guidAssignments: Dictionary<string, string>,
              mutatedEntities: Dictionary<string, AtlasEntityHeader[]>,
              partialUpdatedEntities: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  classificationNames: [string],
                  classifications: [
                    {
                      attributes: Dictionary<string, AnyObject>,
                      typeName: string,
                      lastModifiedTS: string,
                      entityGuid: string,
                      entityStatus: "ACTIVE" | "DELETED",
                      removePropagationsOnEntityDelete: boolean,
                      validityPeriods: [
                        {
                          endTime: string,
                          startTime: string,
                          timeZone: string
                        }
                      ],
                      source: string,
                      sourceDetails: Dictionary<string, AnyObject>
                    }
                  ],
                  displayText: string,
                  guid: string,
                  isIncomplete: boolean,
                  labels: [string],
                  meaningNames: [string],
                  meanings: [
                    {
                      confidence: number,
                      createdBy: string,
                      description: string,
                      displayText: string,
                      expression: string,
                      relationGuid: string,
                      source: string,
                      status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                      steward: string,
                      termGuid: string
                    }
                  ],
                  status: "ACTIVE" | "DELETED"
                }
              ]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }