xml/Azure.Analytics.Purview.DataMap/Entity.xml

<Type Name="Entity" FullName="Azure.Analytics.Purview.DataMap.Entity"> <TypeSignature Language="C#" Value="public class Entity" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Entity extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.Analytics.Purview.DataMap.Entity" /> <TypeSignature Language="VB.NET" Value="Public Class Entity" /> <TypeSignature Language="F#" Value="type Entity = class" /> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The Entity sub-client. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Entity ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of Entity for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AddClassification"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassification (Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassification(class Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassification(Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassification (body As ClassificationAssociateConfig, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassification : Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig * System.Threading.CancellationToken -> Azure.Response
override this.AddClassification : Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddClassification (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Associate a classification to multiple entities in bulk. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call AddClassification. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); ClassificationAssociateConfig body = new ClassificationAssociateConfig { Classification = new AtlasClassification { Attributes = { }, TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", ValidityPeriods = { }, }, EntityGuids = { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, }; Response response = client.AddClassification(body); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassification"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassification (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassification(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassification(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassification (content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassification : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddClassification : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.AddClassification (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Associate a classification to multiple entities in bulk. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassification(Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassification. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { classification = new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", attributes = new object(), validityPeriods = Array.Empty<object>(), }, entityGuids = new object[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, }); Response response = client.AddClassification(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationAsync (Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationAsync(class Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationAsync(Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationAsync (body As ClassificationAssociateConfig, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationAsync : Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationAsync : Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationAsync (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Associate a classification to multiple entities in bulk. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call AddClassificationAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); ClassificationAssociateConfig body = new ClassificationAssociateConfig { Classification = new AtlasClassification { Attributes = { }, TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", ValidityPeriods = { }, }, EntityGuids = { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, }; Response response = await client.AddClassificationAsync(body); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationAsync(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationAsync (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Associate a classification to multiple entities in bulk. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationAsync(Azure.Analytics.Purview.DataMap.ClassificationAssociateConfig,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassificationAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { classification = new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", attributes = new object(), validityPeriods = Array.Empty<object>(), }, entityGuids = new object[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, }); Response response = await client.AddClassificationAsync(content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassifications (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassifications(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassifications(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassifications (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassifications : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddClassifications : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.AddClassifications (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add classifications to an existing entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassifications(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", entityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", entityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", } }); Response response = client.AddClassifications("cc0730ba-9b30-41f0-6953-559d17626d2b", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassifications (string guid, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassifications(string guid, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassifications(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassifications (guid As String, body As IEnumerable(Of AtlasClassification), Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response
override this.AddClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddClassifications (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> An array of classifications to be added. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add classifications to an existing entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddClassifications("cc0730ba-9b30-41f0-6953-559d17626d2b", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", EntityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", EntityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationsAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationsAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationsAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add classifications to an existing entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", entityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", entityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", } }); Response response = await client.AddClassificationsAsync("cc0730ba-9b30-41f0-6953-559d17626d2b", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationsAsync (string guid, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationsAsync(string guid, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsAsync (guid As String, body As IEnumerable(Of AtlasClassification), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationsAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationsAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> An array of classifications to be added. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add classifications to an existing entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddClassificationsAsync("cc0730ba-9b30-41f0-6953-559d17626d2b", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", EntityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", EntityGuid = "cc0730ba-9b30-41f0-6953-559d17626d2b", } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassificationsByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassificationsByUniqueAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.AddClassificationsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.AddClassificationsByUniqueAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add classification to the entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassificationsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); Response response = client.AddClassificationsByUniqueAttribute("azure_storage_account", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddClassificationsByUniqueAttribute (string typeName, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddClassificationsByUniqueAttribute(string typeName, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsByUniqueAttribute (typeName As String, body As IEnumerable(Of AtlasClassification), Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsByUniqueAttribute : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> Azure.Response
override this.AddClassificationsByUniqueAttribute : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddClassificationsByUniqueAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> An array of classification to be added. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add classification to the entity identified by its type and unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddClassificationsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddClassificationsByUniqueAttribute("azure_storage_account", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationsByUniqueAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationsByUniqueAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsByUniqueAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationsByUniqueAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add classification to the entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddClassificationsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); Response response = await client.AddClassificationsByUniqueAttributeAsync("azure_storage_account", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddClassificationsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddClassificationsByUniqueAttributeAsync (string typeName, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddClassificationsByUniqueAttributeAsync(string typeName, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddClassificationsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddClassificationsByUniqueAttributeAsync (typeName As String, body As IEnumerable(Of AtlasClassification), Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddClassificationsByUniqueAttributeAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddClassificationsByUniqueAttributeAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddClassificationsByUniqueAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> An array of classification to be added. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add classification to the entity identified by its type and unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddClassificationsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddClassificationsByUniqueAttributeAsync("azure_storage_account", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabel"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddLabel (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddLabel(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabel(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabel (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddLabel : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddLabel : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.AddLabel (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add given labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddLabel(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddLabel. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = client.AddLabel("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabel"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddLabel (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddLabel(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabel(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabel (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddLabel : string * seq<string> * System.Threading.CancellationToken -> Azure.Response
override this.AddLabel : string * seq<string> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddLabel (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be added. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add given labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddLabel. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddLabel("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddLabelAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddLabelAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddLabelAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddLabelAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddLabelAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add given labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddLabelAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = await client.AddLabelAsync("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddLabelAsync (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddLabelAsync(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelAsync (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddLabelAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddLabelAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddLabelAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be added. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add given labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddLabelAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddLabelAsync("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddLabelsByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddLabelsByUniqueAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelsByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.AddLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.AddLabelsByUniqueAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label3" }); Response response = client.AddLabelsByUniqueAttribute("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddLabelsByUniqueAttribute (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddLabelsByUniqueAttribute(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelsByUniqueAttribute (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response
override this.AddLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddLabelsByUniqueAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be added. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddLabelsByUniqueAttribute("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddLabelsByUniqueAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddLabelsByUniqueAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelsByUniqueAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddLabelsByUniqueAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label3" }); Response response = await client.AddLabelsByUniqueAttributeAsync("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddLabelsByUniqueAttributeAsync (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddLabelsByUniqueAttributeAsync(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddLabelsByUniqueAttributeAsync (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddLabelsByUniqueAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be added. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddLabelsByUniqueAttributeAsync("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddOrUpdateBusinessMetadata (string guid, Azure.Core.RequestContent content, bool? overwrite = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddOrUpdateBusinessMetadata(string guid, class Azure.Core.RequestContent content, valuetype System.Nullable`1<bool> overwrite, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadata(System.String,Azure.Core.RequestContent,System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadata (guid As String, content As RequestContent, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadata : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.AddOrUpdateBusinessMetadata : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="entity.AddOrUpdateBusinessMetadata (guid, content, overwrite, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="overwrite" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="overwrite"> Whether to overwrite the existing business metadata on the entity or not, default is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add business metadata to an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadata(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadata. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { myBizMetadata1 = new { bizAttr1 = "myBizMetaData1.bizAttr1", }, }); Response response = client.AddOrUpdateBusinessMetadata("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddOrUpdateBusinessMetadata (string guid, System.Collections.Generic.IDictionary<string,System.Collections.Generic.IDictionary<string,BinaryData>> body, bool? overwrite = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddOrUpdateBusinessMetadata(string guid, class System.Collections.Generic.IDictionary`2<string, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData>> body, valuetype System.Nullable`1<bool> overwrite, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadata(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadata (guid As String, body As IDictionary(Of String, IDictionary(Of String, BinaryData)), Optional overwrite As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadata : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response
override this.AddOrUpdateBusinessMetadata : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddOrUpdateBusinessMetadata (guid, body, overwrite, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IDictionary<System.String,System.BinaryData>>" /> <Parameter Name="overwrite" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> BusinessMetadata payload. </param> <param name="overwrite"> Whether to overwrite the existing business metadata on the entity or not, default is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add business metadata to an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadata. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddOrUpdateBusinessMetadata("02c373fe-2823-4be3-97fa-55180a9faa06", new Dictionary<string, IDictionary<string, BinaryData>> { ["myBizMetadata1"] = new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("myBizMetaData1.bizAttr1") } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddOrUpdateBusinessMetadataAsync (string guid, Azure.Core.RequestContent content, bool? overwrite = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddOrUpdateBusinessMetadataAsync(string guid, class Azure.Core.RequestContent content, valuetype System.Nullable`1<bool> overwrite, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAsync(System.String,Azure.Core.RequestContent,System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAsync (guid As String, content As RequestContent, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddOrUpdateBusinessMetadataAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddOrUpdateBusinessMetadataAsync (guid, content, overwrite, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="overwrite" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="overwrite"> Whether to overwrite the existing business metadata on the entity or not, default is false. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add business metadata to an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { myBizMetadata1 = new { bizAttr1 = "myBizMetaData1.bizAttr1", }, }); Response response = await client.AddOrUpdateBusinessMetadataAsync("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddOrUpdateBusinessMetadataAsync (string guid, System.Collections.Generic.IDictionary<string,System.Collections.Generic.IDictionary<string,BinaryData>> body, bool? overwrite = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddOrUpdateBusinessMetadataAsync(string guid, class System.Collections.Generic.IDictionary`2<string, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData>> body, valuetype System.Nullable`1<bool> overwrite, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAsync (guid As String, body As IDictionary(Of String, IDictionary(Of String, BinaryData)), Optional overwrite As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAsync : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddOrUpdateBusinessMetadataAsync : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddOrUpdateBusinessMetadataAsync (guid, body, overwrite, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IDictionary<System.String,System.BinaryData>>" /> <Parameter Name="overwrite" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> BusinessMetadata payload. </param> <param name="overwrite"> Whether to overwrite the existing business metadata on the entity or not, default is false. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add business metadata to an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddOrUpdateBusinessMetadataAsync("02c373fe-2823-4be3-97fa-55180a9faa06", new Dictionary<string, IDictionary<string, BinaryData>> { ["myBizMetadata1"] = new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("myBizMetaData1.bizAttr1") } }); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddOrUpdateBusinessMetadataAttributes (string guid, string businessMetadataName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddOrUpdateBusinessMetadataAttributes(string guid, string businessMetadataName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributes(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAttributes (guid As String, businessMetadataName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAttributes : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddOrUpdateBusinessMetadataAttributes : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.AddOrUpdateBusinessMetadataAttributes (guid, businessMetadataName, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add or update business metadata attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributes(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAttributes. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { bizAttr1 = "bizAttr1", }); Response response = client.AddOrUpdateBusinessMetadataAttributes("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddOrUpdateBusinessMetadataAttributes (string guid, string businessMetadataName, System.Collections.Generic.IDictionary<string,BinaryData> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddOrUpdateBusinessMetadataAttributes(string guid, string businessMetadataName, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributes(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAttributes (guid As String, businessMetadataName As String, body As IDictionary(Of String, BinaryData), Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAttributes : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> Azure.Response
override this.AddOrUpdateBusinessMetadataAttributes : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.AddOrUpdateBusinessMetadataAttributes (guid, businessMetadataName, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.BinaryData>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="body"> Business metadata attribute payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add or update business metadata attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAttributes. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.AddOrUpdateBusinessMetadataAttributes("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("bizAttr1") }); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddOrUpdateBusinessMetadataAttributesAsync (string guid, string businessMetadataName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddOrUpdateBusinessMetadataAttributesAsync(string guid, string businessMetadataName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributesAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAttributesAsync (guid As String, businessMetadataName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAttributesAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddOrUpdateBusinessMetadataAttributesAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddOrUpdateBusinessMetadataAttributesAsync (guid, businessMetadataName, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add or update business metadata attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributesAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAttributesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { bizAttr1 = "bizAttr1", }); Response response = await client.AddOrUpdateBusinessMetadataAttributesAsync("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBusinessMetadataAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddOrUpdateBusinessMetadataAttributesAsync (string guid, string businessMetadataName, System.Collections.Generic.IDictionary<string,BinaryData> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddOrUpdateBusinessMetadataAttributesAsync(string guid, string businessMetadataName, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.AddOrUpdateBusinessMetadataAttributesAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBusinessMetadataAttributesAsync (guid As String, businessMetadataName As String, body As IDictionary(Of String, BinaryData), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBusinessMetadataAttributesAsync : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.AddOrUpdateBusinessMetadataAttributesAsync : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.AddOrUpdateBusinessMetadataAttributesAsync (guid, businessMetadataName, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.BinaryData>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="body"> Business metadata attribute payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add or update business metadata attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBusinessMetadataAttributesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.AddOrUpdateBusinessMetadataAttributesAsync("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("bizAttr1") }); ]]></code></example> </Docs> </Member> <Member MemberName="BatchCreateOrUpdate"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> BatchCreateOrUpdate (Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo body, string collectionId = default, Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior? businessAttributeUpdateBehavior = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> BatchCreateOrUpdate(class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo body, string collectionId, valuetype System.Nullable`1<valuetype Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> businessAttributeUpdateBehavior, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdate(Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo,System.String,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchCreateOrUpdate (body As AtlasEntitiesWithExtInfo, Optional collectionId As String = Nothing, Optional businessAttributeUpdateBehavior As Nullable(Of BusinessAttributeUpdateBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member BatchCreateOrUpdate : Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo * string * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.BatchCreateOrUpdate : Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo * string * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.BatchCreateOrUpdate (body, collectionId, businessAttributeUpdateBehavior, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> 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. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call BatchCreateOrUpdate. <code><![CDATA[ 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 = client.BatchCreateOrUpdate(body); ]]></code></example> </Docs> </Member> <Member MemberName="BatchCreateOrUpdate"> <MemberSignature Language="C#" Value="public virtual Azure.Response BatchCreateOrUpdate (Azure.Core.RequestContent content, string collectionId = default, string businessAttributeUpdateBehavior = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response BatchCreateOrUpdate(class Azure.Core.RequestContent content, string collectionId, string businessAttributeUpdateBehavior, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdate(Azure.Core.RequestContent,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchCreateOrUpdate (content As RequestContent, Optional collectionId As String = Nothing, Optional businessAttributeUpdateBehavior As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member BatchCreateOrUpdate : Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Response
override this.BatchCreateOrUpdate : Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Response" Usage="entity.BatchCreateOrUpdate (content, collectionId, businessAttributeUpdateBehavior, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore" | "replace" | "merge" </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [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. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdate(Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo,System.String,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchCreateOrUpdate and parse the result. <code><![CDATA[ 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 = client.BatchCreateOrUpdate(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchCreateOrUpdateAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> BatchCreateOrUpdateAsync(class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo body, string collectionId, valuetype System.Nullable`1<valuetype Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> businessAttributeUpdateBehavior, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdateAsync(Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo,System.String,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="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))" /> <MemberSignature Language="F#" Value="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>>" Usage="entity.BatchCreateOrUpdateAsync (body, collectionId, businessAttributeUpdateBehavior, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> 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. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call BatchCreateOrUpdateAsync. <code><![CDATA[ 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); ]]></code></example> </Docs> </Member> <Member MemberName="BatchCreateOrUpdateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> BatchCreateOrUpdateAsync (Azure.Core.RequestContent content, string collectionId = default, string businessAttributeUpdateBehavior = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> BatchCreateOrUpdateAsync(class Azure.Core.RequestContent content, string collectionId, string businessAttributeUpdateBehavior, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdateAsync(Azure.Core.RequestContent,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="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)" /> <MemberSignature Language="F#" Value="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>" Usage="entity.BatchCreateOrUpdateAsync (content, collectionId, businessAttributeUpdateBehavior, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore" | "replace" | "merge" </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [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. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchCreateOrUpdateAsync(Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo,System.String,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchCreateOrUpdateAsync and parse the result. <code><![CDATA[ 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()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchDelete"> <MemberSignature Language="C#" Value="public virtual Azure.Response BatchDelete (System.Collections.Generic.IEnumerable<string> guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response BatchDelete(class System.Collections.Generic.IEnumerable`1<string> guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchDelete(System.Collections.Generic.IEnumerable{System.String},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchDelete (guid As IEnumerable(Of String), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member BatchDelete : seq<string> * Azure.RequestContext -> Azure.Response
override this.BatchDelete : seq<string> * Azure.RequestContext -> Azure.Response" Usage="entity.BatchDelete (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to delete. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a list of entities in bulk identified by their GUIDs or unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchDelete(System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchDelete and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.BatchDelete(new string[] { "18e06957-e265-967a-07f1-e14e2ab8940f", "cc0730ba-9b30-41f0-6953-559d17626d2b" }, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchDelete"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> BatchDelete (System.Collections.Generic.IEnumerable<string> guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> BatchDelete(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchDelete(System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchDelete (guid As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member BatchDelete : seq<string> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.BatchDelete : seq<string> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.BatchDelete (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to delete. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete a list of entities in bulk identified by their GUIDs or unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <example> This sample shows how to call BatchDelete. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = client.BatchDelete(new string[] { "18e06957-e265-967a-07f1-e14e2ab8940f", "cc0730ba-9b30-41f0-6953-559d17626d2b" }); ]]></code></example> </Docs> </Member> <Member MemberName="BatchDeleteAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> BatchDeleteAsync (System.Collections.Generic.IEnumerable<string> guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> BatchDeleteAsync(class System.Collections.Generic.IEnumerable`1<string> guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchDeleteAsync(System.Collections.Generic.IEnumerable{System.String},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchDeleteAsync (guid As IEnumerable(Of String), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member BatchDeleteAsync : seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.BatchDeleteAsync : seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.BatchDeleteAsync (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to delete. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a list of entities in bulk identified by their GUIDs or unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchDeleteAsync(System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchDeleteAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.BatchDeleteAsync(new string[] { "18e06957-e265-967a-07f1-e14e2ab8940f", "cc0730ba-9b30-41f0-6953-559d17626d2b" }, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchDeleteAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> BatchDeleteAsync (System.Collections.Generic.IEnumerable<string> guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> BatchDeleteAsync(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchDeleteAsync(System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchDeleteAsync (guid As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member BatchDeleteAsync : seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.BatchDeleteAsync : seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.BatchDeleteAsync (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to delete. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete a list of entities in bulk identified by their GUIDs or unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <example> This sample shows how to call BatchDeleteAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = await client.BatchDeleteAsync(new string[] { "18e06957-e265-967a-07f1-e14e2ab8940f", "cc0730ba-9b30-41f0-6953-559d17626d2b" }); ]]></code></example> </Docs> </Member> <Member MemberName="BatchGetByUniqueAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response BatchGetByUniqueAttributes (string typeName, bool? minExtInfo, bool? ignoreRelationships, string attrNQualifiedName, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response BatchGetByUniqueAttributes(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attrNQualifiedName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributes(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchGetByUniqueAttributes (typeName As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), attrNQualifiedName As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member BatchGetByUniqueAttributes : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> Azure.Response
override this.BatchGetByUniqueAttributes : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> Azure.Response" Usage="entity.BatchGetByUniqueAttributes (typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attrNQualifiedName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attrNQualifiedName"> Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributes(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchGetByUniqueAttributes and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.BatchGetByUniqueAttributes("azure_storage_account", true, null, "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchGetByUniqueAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo> BatchGetByUniqueAttributes (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attrNQualifiedName = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo> BatchGetByUniqueAttributes(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attrNQualifiedName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributes(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchGetByUniqueAttributes (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attrNQualifiedName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasEntitiesWithExtInfo)" /> <MemberSignature Language="F#" Value="abstract member BatchGetByUniqueAttributes : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>
override this.BatchGetByUniqueAttributes : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>" Usage="entity.BatchGetByUniqueAttributes (typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attrNQualifiedName" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attrNQualifiedName"> Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call BatchGetByUniqueAttributes. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntitiesWithExtInfo> response = client.BatchGetByUniqueAttributes("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="BatchGetByUniqueAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> BatchGetByUniqueAttributesAsync (string typeName, bool? minExtInfo, bool? ignoreRelationships, string attrNQualifiedName, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> BatchGetByUniqueAttributesAsync(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attrNQualifiedName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributesAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchGetByUniqueAttributesAsync (typeName As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), attrNQualifiedName As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member BatchGetByUniqueAttributesAsync : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.BatchGetByUniqueAttributesAsync : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.BatchGetByUniqueAttributesAsync (typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attrNQualifiedName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attrNQualifiedName"> Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributesAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchGetByUniqueAttributesAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.BatchGetByUniqueAttributesAsync("azure_storage_account", true, null, "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchGetByUniqueAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>> BatchGetByUniqueAttributesAsync (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attrNQualifiedName = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>> BatchGetByUniqueAttributesAsync(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attrNQualifiedName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchGetByUniqueAttributesAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchGetByUniqueAttributesAsync (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attrNQualifiedName As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntitiesWithExtInfo))" /> <MemberSignature Language="F#" Value="abstract member BatchGetByUniqueAttributesAsync : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>
override this.BatchGetByUniqueAttributesAsync : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>" Usage="entity.BatchGetByUniqueAttributesAsync (typeName, minExtInfo, ignoreRelationships, attrNQualifiedName, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attrNQualifiedName" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attrNQualifiedName"> Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format typeName=\<typeName>&attr_1:\<attrName>=\<attrValue>&attr_2:\<attrName>=\<attrValue>&attr_3:\<attrName>=\<attrValue> NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call BatchGetByUniqueAttributesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntitiesWithExtInfo> response = await client.BatchGetByUniqueAttributesAsync("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="BatchSetClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<string>> BatchSetClassifications (Azure.Analytics.Purview.DataMap.AtlasEntityHeaders body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<string>> BatchSetClassifications(class Azure.Analytics.Purview.DataMap.AtlasEntityHeaders body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassifications(Azure.Analytics.Purview.DataMap.AtlasEntityHeaders,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchSetClassifications (body As AtlasEntityHeaders, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of String))" /> <MemberSignature Language="F#" Value="abstract member BatchSetClassifications : Azure.Analytics.Purview.DataMap.AtlasEntityHeaders * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<string>>
override this.BatchSetClassifications : Azure.Analytics.Purview.DataMap.AtlasEntityHeaders * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<string>>" Usage="entity.BatchSetClassifications (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<System.Collections.Generic.IReadOnlyList<System.String>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityHeaders" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set classifications on entities in bulk. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call BatchSetClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); AtlasEntityHeaders body = new AtlasEntityHeaders { GuidHeaderMap = { ["9fb74c11-ac48-4650-95bc-760665c5bd92"] = new AtlasEntityHeader { Attributes = { ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount1.core.windows.net") }, TypeName = "azure_storage_account", Classifications = {new AtlasClassification { TypeName = "MICROSOFT.PERSONAL.EMAIL", }}, }, ["7fcc43ab-55ea-45d4-9971-ce0443cb10bb"] = new AtlasEntityHeader { Attributes = { ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount2.core.windows.net") }, TypeName = "azure_storage_account", Classifications = {new AtlasClassification { TypeName = "MICROSOFT.PERSONAL.IPADDRESS", }}, } }, }; Response<IReadOnlyList<string>> response = client.BatchSetClassifications(body); ]]></code></example> </Docs> </Member> <Member MemberName="BatchSetClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response BatchSetClassifications (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response BatchSetClassifications(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassifications(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchSetClassifications (content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member BatchSetClassifications : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.BatchSetClassifications : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.BatchSetClassifications (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set classifications on entities in bulk. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassifications(Azure.Analytics.Purview.DataMap.AtlasEntityHeaders,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchSetClassifications and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { guidHeaderMap = new Dictionary<string, object> { ["9fb74c11-ac48-4650-95bc-760665c5bd92"] = new { attributes = new { qualifiedName = "https://exampleaccount1.core.windows.net", }, typeName = "azure_storage_account", classifications = new object[] { new { typeName = "MICROSOFT.PERSONAL.EMAIL", } }, }, ["7fcc43ab-55ea-45d4-9971-ce0443cb10bb"] = new { attributes = new { qualifiedName = "https://exampleaccount2.core.windows.net", }, typeName = "azure_storage_account", classifications = new object[] { new { typeName = "MICROSOFT.PERSONAL.IPADDRESS", } }, } }, }); Response response = client.BatchSetClassifications(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="BatchSetClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<string>>> BatchSetClassificationsAsync (Azure.Analytics.Purview.DataMap.AtlasEntityHeaders body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<string>>> BatchSetClassificationsAsync(class Azure.Analytics.Purview.DataMap.AtlasEntityHeaders body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassificationsAsync(Azure.Analytics.Purview.DataMap.AtlasEntityHeaders,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchSetClassificationsAsync (body As AtlasEntityHeaders, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of String)))" /> <MemberSignature Language="F#" Value="abstract member BatchSetClassificationsAsync : Azure.Analytics.Purview.DataMap.AtlasEntityHeaders * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<string>>>
override this.BatchSetClassificationsAsync : Azure.Analytics.Purview.DataMap.AtlasEntityHeaders * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<string>>>" Usage="entity.BatchSetClassificationsAsync (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<System.String>>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityHeaders" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set classifications on entities in bulk. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call BatchSetClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); AtlasEntityHeaders body = new AtlasEntityHeaders { GuidHeaderMap = { ["9fb74c11-ac48-4650-95bc-760665c5bd92"] = new AtlasEntityHeader { Attributes = { ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount1.core.windows.net") }, TypeName = "azure_storage_account", Classifications = {new AtlasClassification { TypeName = "MICROSOFT.PERSONAL.EMAIL", }}, }, ["7fcc43ab-55ea-45d4-9971-ce0443cb10bb"] = new AtlasEntityHeader { Attributes = { ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount2.core.windows.net") }, TypeName = "azure_storage_account", Classifications = {new AtlasClassification { TypeName = "MICROSOFT.PERSONAL.IPADDRESS", }}, } }, }; Response<IReadOnlyList<string>> response = await client.BatchSetClassificationsAsync(body); ]]></code></example> </Docs> </Member> <Member MemberName="BatchSetClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> BatchSetClassificationsAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> BatchSetClassificationsAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassificationsAsync(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function BatchSetClassificationsAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member BatchSetClassificationsAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.BatchSetClassificationsAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.BatchSetClassificationsAsync (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set classifications on entities in bulk. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.BatchSetClassificationsAsync(Azure.Analytics.Purview.DataMap.AtlasEntityHeaders,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call BatchSetClassificationsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { guidHeaderMap = new Dictionary<string, object> { ["9fb74c11-ac48-4650-95bc-760665c5bd92"] = new { attributes = new { qualifiedName = "https://exampleaccount1.core.windows.net", }, typeName = "azure_storage_account", classifications = new object[] { new { typeName = "MICROSOFT.PERSONAL.EMAIL", } }, }, ["7fcc43ab-55ea-45d4-9971-ce0443cb10bb"] = new { attributes = new { qualifiedName = "https://exampleaccount2.core.windows.net", }, typeName = "azure_storage_account", classifications = new object[] { new { typeName = "MICROSOFT.PERSONAL.IPADDRESS", } }, } }, }); Response response = await client.BatchSetClassificationsAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result[0].ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdate"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> CreateOrUpdate (Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior? businessAttributeUpdateBehavior = default, string collectionId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> CreateOrUpdate(class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, valuetype System.Nullable`1<valuetype Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> businessAttributeUpdateBehavior, string collectionId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdate(Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdate (body As AtlasEntityWithExtInfo, Optional businessAttributeUpdateBehavior As Nullable(Of BusinessAttributeUpdateBehavior) = Nothing, Optional collectionId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdate : Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.CreateOrUpdate : Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.CreateOrUpdate (body, businessAttributeUpdateBehavior, collectionId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior>" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Create or update an entity. 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. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call CreateOrUpdate. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["description"] = null, ["publicAccessLevel"] = null }, TypeName = "azure_storage_account", CustomAttributes = { ["custAttr1"] = "attr1", ["custAttr2"] = "attr2" }, }, }; Response<EntityMutationResult> response = client.CreateOrUpdate(body); ]]></code> This sample shows how to call CreateOrUpdate. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["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", } } }, }, }; Response<EntityMutationResult> response = client.CreateOrUpdate(body); ]]></code> This sample shows how to call CreateOrUpdate. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["description"] = null, ["userDescription"] = BinaryData.FromObjectAsJson("<div><b>testing</b></div>"), ["publicAccessLevel"] = null }, TypeName = "azure_storage_account", CreatedBy = "ExampleCreator", CustomAttributes = { ["microsoft_isDescriptionRichText"] = "true" }, Status = EntityStatus.Active, UpdatedBy = "ExampleUpdator", Version = 0L, }, }; Response<EntityMutationResult> response = client.CreateOrUpdate(body); ]]></code> This sample shows how to call CreateOrUpdate. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("exampleaccount"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["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", } } }, }, }; Response<EntityMutationResult> response = client.CreateOrUpdate(body); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdate"> <MemberSignature Language="C#" Value="public virtual Azure.Response CreateOrUpdate (Azure.Core.RequestContent content, string businessAttributeUpdateBehavior = default, string collectionId = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateOrUpdate(class Azure.Core.RequestContent content, string businessAttributeUpdateBehavior, string collectionId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdate(Azure.Core.RequestContent,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdate (content As RequestContent, Optional businessAttributeUpdateBehavior As String = Nothing, Optional collectionId As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdate : Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Response
override this.CreateOrUpdate : Azure.Core.RequestContent * string * string * Azure.RequestContext -> Azure.Response" Usage="entity.CreateOrUpdate (content, businessAttributeUpdateBehavior, collectionId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.String" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore" | "replace" | "merge" </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create or update an entity. 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. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdate(Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateOrUpdate and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", }, customAttributes = new { custAttr1 = "attr1", custAttr2 = "attr2", }, }, }); Response response = client.CreateOrUpdate(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdate and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", }, 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 = client.CreateOrUpdate(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdate and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", userDescription = "<div><b>testing</b></div>", }, customAttributes = new { microsoft_isDescriptionRichText = "true", }, status = "ACTIVE", createdBy = "ExampleCreator", updatedBy = "ExampleUpdator", version = 0L, }, }); Response response = client.CreateOrUpdate(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdate and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "exampleaccount", name = "ExampleStorageAccount", }, 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 = client.CreateOrUpdate(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> CreateOrUpdateAsync (Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior? businessAttributeUpdateBehavior = default, string collectionId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> CreateOrUpdateAsync(class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, valuetype System.Nullable`1<valuetype Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> businessAttributeUpdateBehavior, string collectionId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdateAsync(Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateAsync (body As AtlasEntityWithExtInfo, Optional businessAttributeUpdateBehavior As Nullable(Of BusinessAttributeUpdateBehavior) = Nothing, Optional collectionId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdateAsync : Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.CreateOrUpdateAsync : Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.CreateOrUpdateAsync (body, businessAttributeUpdateBehavior, collectionId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.Nullable<Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior>" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Create or update an entity. 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. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call CreateOrUpdateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["description"] = null, ["publicAccessLevel"] = null }, TypeName = "azure_storage_account", CustomAttributes = { ["custAttr1"] = "attr1", ["custAttr2"] = "attr2" }, }, }; Response<EntityMutationResult> response = await client.CreateOrUpdateAsync(body); ]]></code> This sample shows how to call CreateOrUpdateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["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", } } }, }, }; Response<EntityMutationResult> response = await client.CreateOrUpdateAsync(body); ]]></code> This sample shows how to call CreateOrUpdateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["description"] = null, ["userDescription"] = BinaryData.FromObjectAsJson("<div><b>testing</b></div>"), ["publicAccessLevel"] = null }, TypeName = "azure_storage_account", CreatedBy = "ExampleCreator", CustomAttributes = { ["microsoft_isDescriptionRichText"] = "true" }, Status = EntityStatus.Active, UpdatedBy = "ExampleUpdator", Version = 0L, }, }; Response<EntityMutationResult> response = await client.CreateOrUpdateAsync(body); ]]></code> This sample shows how to call CreateOrUpdateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["modifiedTime"] = BinaryData.FromObjectAsJson(0), ["createTime"] = BinaryData.FromObjectAsJson(0), ["qualifiedName"] = BinaryData.FromObjectAsJson("exampleaccount"), ["name"] = BinaryData.FromObjectAsJson("ExampleStorageAccount"), ["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", } } }, }, }; Response<EntityMutationResult> response = await client.CreateOrUpdateAsync(body); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateAsync (Azure.Core.RequestContent content, string businessAttributeUpdateBehavior = default, string collectionId = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateOrUpdateAsync(class Azure.Core.RequestContent content, string businessAttributeUpdateBehavior, string collectionId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdateAsync(Azure.Core.RequestContent,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateAsync (content As RequestContent, Optional businessAttributeUpdateBehavior As String = Nothing, Optional collectionId As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdateAsync : Azure.Core.RequestContent * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrUpdateAsync : Azure.Core.RequestContent * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.CreateOrUpdateAsync (content, businessAttributeUpdateBehavior, collectionId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="businessAttributeUpdateBehavior" Type="System.String" /> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="businessAttributeUpdateBehavior"> Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore" | "replace" | "merge" </param> <param name="collectionId"> The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create or update an entity. 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. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.CreateOrUpdateAsync(Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.Nullable{Azure.Analytics.Purview.DataMap.BusinessAttributeUpdateBehavior},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateOrUpdateAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", }, customAttributes = new { custAttr1 = "attr1", custAttr2 = "attr2", }, }, }); Response response = await client.CreateOrUpdateAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdateAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", }, 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.CreateOrUpdateAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdateAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "https://exampleaccount.core.windows.net", name = "ExampleStorageAccount", userDescription = "<div><b>testing</b></div>", }, customAttributes = new { microsoft_isDescriptionRichText = "true", }, status = "ACTIVE", createdBy = "ExampleCreator", updatedBy = "ExampleUpdator", version = 0L, }, }); Response response = await client.CreateOrUpdateAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call CreateOrUpdateAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { referredEntities = new object(), entity = new { typeName = "azure_storage_account", attributes = new { owner = "ExampleOwner", modifiedTime = 0, createTime = 0, qualifiedName = "exampleaccount", name = "ExampleStorageAccount", }, 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.CreateOrUpdateAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="Delete"> <MemberSignature Language="C#" Value="public virtual Azure.Response Delete (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Delete(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.Delete(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Delete (guid As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member Delete : string * Azure.RequestContext -> Azure.Response
override this.Delete : string * Azure.RequestContext -> Azure.Response" Usage="entity.Delete (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete an entity identified by its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.Delete(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Delete and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.Delete("fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="Delete"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> Delete (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> Delete(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.Delete(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Delete (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member Delete : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.Delete : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.Delete (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete an entity identified by its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call Delete. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = client.Delete("fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f"); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteAsync(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteAsync (guid As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.DeleteAsync (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete an entity identified by its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.DeleteAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.DeleteAsync("fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> DeleteAsync (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> DeleteAsync(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteAsync (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.DeleteAsync (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete an entity identified by its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call DeleteAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = await client.DeleteAsync("fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f"); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response DeleteByUniqueAttribute (string typeName, string attribute, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteByUniqueAttribute(string typeName, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttribute(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteByUniqueAttribute (typeName As String, attribute As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member DeleteByUniqueAttribute : string * string * Azure.RequestContext -> Azure.Response
override this.DeleteByUniqueAttribute : string * string * Azure.RequestContext -> Azure.Response" Usage="entity.DeleteByUniqueAttribute (typeName, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=\<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttribute(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteByUniqueAttribute and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.DeleteByUniqueAttribute("azure_storage_account", "https://exampleaccount.core.windows.net", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> DeleteByUniqueAttribute (string typeName, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> DeleteByUniqueAttribute(string typeName, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttribute(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteByUniqueAttribute (typeName As String, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member DeleteByUniqueAttribute : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.DeleteByUniqueAttribute : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.DeleteByUniqueAttribute (typeName, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=\<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call DeleteByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = client.DeleteByUniqueAttribute("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteByUniqueAttributeAsync (string typeName, string attribute, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteByUniqueAttributeAsync(string typeName, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttributeAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteByUniqueAttributeAsync (typeName As String, attribute As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteByUniqueAttributeAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteByUniqueAttributeAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.DeleteByUniqueAttributeAsync (typeName, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=\<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttributeAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteByUniqueAttributeAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.DeleteByUniqueAttributeAsync("azure_storage_account", "https://exampleaccount.core.windows.net", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> DeleteByUniqueAttributeAsync (string typeName, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> DeleteByUniqueAttributeAsync(string typeName, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.DeleteByUniqueAttributeAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteByUniqueAttributeAsync (typeName As String, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member DeleteByUniqueAttributeAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.DeleteByUniqueAttributeAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.DeleteByUniqueAttributeAsync (typeName, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=\<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call DeleteByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = await client.DeleteByUniqueAttributeAsync("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="GetBusinessMetadataTemplate"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetBusinessMetadataTemplate (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetBusinessMetadataTemplate(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplate(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetBusinessMetadataTemplate (context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetBusinessMetadataTemplate : Azure.RequestContext -> Azure.Response
override this.GetBusinessMetadataTemplate : Azure.RequestContext -> Azure.Response" Usage="entity.GetBusinessMetadataTemplate context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get the sample Template for uploading/creating bulk BusinessMetaData <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplate(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetBusinessMetadataTemplate and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetBusinessMetadataTemplate(null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetBusinessMetadataTemplate"> <MemberSignature Language="C#" Value="public virtual Azure.Response<BinaryData> GetBusinessMetadataTemplate (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.BinaryData> GetBusinessMetadataTemplate(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplate(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetBusinessMetadataTemplate (Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetBusinessMetadataTemplate : System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.GetBusinessMetadataTemplate : System.Threading.CancellationToken -> Azure.Response<BinaryData>" Usage="entity.GetBusinessMetadataTemplate cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get the sample Template for uploading/creating bulk BusinessMetaData. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetBusinessMetadataTemplate. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<BinaryData> response = client.GetBusinessMetadataTemplate(); ]]></code></example> </Docs> </Member> <Member MemberName="GetBusinessMetadataTemplateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetBusinessMetadataTemplateAsync (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetBusinessMetadataTemplateAsync(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplateAsync(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetBusinessMetadataTemplateAsync (context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetBusinessMetadataTemplateAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetBusinessMetadataTemplateAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetBusinessMetadataTemplateAsync context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get the sample Template for uploading/creating bulk BusinessMetaData <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplateAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetBusinessMetadataTemplateAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetBusinessMetadataTemplateAsync(null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetBusinessMetadataTemplateAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<BinaryData>> GetBusinessMetadataTemplateAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.BinaryData>> GetBusinessMetadataTemplateAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetBusinessMetadataTemplateAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetBusinessMetadataTemplateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member GetBusinessMetadataTemplateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>
override this.GetBusinessMetadataTemplateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>" Usage="entity.GetBusinessMetadataTemplateAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<System.BinaryData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get the sample Template for uploading/creating bulk BusinessMetaData. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetBusinessMetadataTemplateAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<BinaryData> response = await client.GetBusinessMetadataTemplateAsync(); ]]></code></example> </Docs> </Member> <Member MemberName="GetByIds"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetByIds (System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo, bool? ignoreRelationships, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetByIds(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByIds(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByIds (guid As IEnumerable(Of String), minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetByIds : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetByIds : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="entity.GetByIds (guid, minExtInfo, ignoreRelationships, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to list. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List entities in bulk identified by its GUIDs. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetByIds(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetByIds and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetByIds(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, true, null, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetByIds"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo> GetByIds (System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo> GetByIds(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByIds(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByIds (guid As IEnumerable(Of String), Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasEntitiesWithExtInfo)" /> <MemberSignature Language="F#" Value="abstract member GetByIds : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>
override this.GetByIds : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>" Usage="entity.GetByIds (guid, minExtInfo, ignoreRelationships, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to list. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List entities in bulk identified by its GUIDs. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <example> This sample shows how to call GetByIds. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntitiesWithExtInfo> response = client.GetByIds(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }); ]]></code></example> </Docs> </Member> <Member MemberName="GetByIdsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetByIdsAsync (System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo, bool? ignoreRelationships, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetByIdsAsync(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByIdsAsync(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByIdsAsync (guid As IEnumerable(Of String), minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetByIdsAsync (guid, minExtInfo, ignoreRelationships, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to list. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List entities in bulk identified by its GUIDs. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetByIdsAsync(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetByIdsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetByIdsAsync(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }, true, null, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetByIdsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>> GetByIdsAsync (System.Collections.Generic.IEnumerable<string> guid, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>> GetByIdsAsync(class System.Collections.Generic.IEnumerable`1<string> guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByIdsAsync(System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByIdsAsync (guid As IEnumerable(Of String), Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntitiesWithExtInfo))" /> <MemberSignature Language="F#" Value="abstract member GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>
override this.GetByIdsAsync : seq<string> * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>>" Usage="entity.GetByIdsAsync (guid, minExtInfo, ignoreRelationships, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntitiesWithExtInfo>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> An array of GUIDs of entities to list. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List entities in bulk identified by its GUIDs. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <example> This sample shows how to call GetByIdsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntitiesWithExtInfo> response = await client.GetByIdsAsync(new string[] { "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" }); ]]></code></example> </Docs> </Member> <Member MemberName="GetByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetByUniqueAttribute (string typeName, bool? minExtInfo, bool? ignoreRelationships, string attribute, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetByUniqueAttribute(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttribute(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByUniqueAttribute (typeName As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), attribute As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetByUniqueAttribute : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> Azure.Response
override this.GetByUniqueAttribute : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> Azure.Response" Usage="entity.GetByUniqueAttribute (typeName, minExtInfo, ignoreRelationships, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttribute(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetByUniqueAttribute and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetByUniqueAttribute("azure_storage_account", true, null, "https://exampleaccount.core.windows.net", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo> GetByUniqueAttribute (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo> GetByUniqueAttribute(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttribute(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByUniqueAttribute (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasEntityWithExtInfo)" /> <MemberSignature Language="F#" Value="abstract member GetByUniqueAttribute : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>
override this.GetByUniqueAttribute : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>" Usage="entity.GetByUniqueAttribute (typeName, minExtInfo, ignoreRelationships, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityWithExtInfo> response = client.GetByUniqueAttribute("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="GetByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetByUniqueAttributeAsync (string typeName, bool? minExtInfo, bool? ignoreRelationships, string attribute, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetByUniqueAttributeAsync(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttributeAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByUniqueAttributeAsync (typeName As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), attribute As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetByUniqueAttributeAsync : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetByUniqueAttributeAsync : string * Nullable<bool> * Nullable<bool> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetByUniqueAttributeAsync (typeName, minExtInfo, ignoreRelationships, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttributeAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetByUniqueAttributeAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetByUniqueAttributeAsync("azure_storage_account", true, null, "https://exampleaccount.core.windows.net", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>> GetByUniqueAttributeAsync (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>> GetByUniqueAttributeAsync(string typeName, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetByUniqueAttributeAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetByUniqueAttributeAsync (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntityWithExtInfo))" /> <MemberSignature Language="F#" Value="abstract member GetByUniqueAttributeAsync : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>>
override this.GetByUniqueAttributeAsync : string * Nullable<bool> * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>>" Usage="entity.GetByUniqueAttributeAsync (typeName, minExtInfo, ignoreRelationships, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:\<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityWithExtInfo> response = await client.GetByUniqueAttributeAsync("azure_storage_account"); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassification"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetClassification (string guid, string classificationName, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetClassification(string guid, string classificationName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassification(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassification (guid As String, classificationName As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetClassification : string * string * Azure.RequestContext -> Azure.Response
override this.GetClassification : string * string * Azure.RequestContext -> Azure.Response" Usage="entity.GetClassification (guid, classificationName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get classification for a given entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetClassification(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetClassification and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetClassification("9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", "MICROSOFT.PERSONAL.DATE_OF_BIRTH", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassification"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification> GetClassification (string guid, string classificationName, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> GetClassification(string guid, string classificationName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassification(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassification (guid As String, classificationName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasClassification)" /> <MemberSignature Language="F#" Value="abstract member GetClassification : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>
override this.GetClassification : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>" Usage="entity.GetClassification (guid, classificationName, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get classification for a given entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetClassification. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasClassification> response = client.GetClassification("9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", "MICROSOFT.PERSONAL.DATE_OF_BIRTH"); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassificationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetClassificationAsync (string guid, string classificationName, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetClassificationAsync(string guid, string classificationName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassificationAsync (guid As String, classificationName As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetClassificationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetClassificationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetClassificationAsync (guid, classificationName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get classification for a given entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetClassificationAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetClassificationAsync("9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", "MICROSOFT.PERSONAL.DATE_OF_BIRTH", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassificationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>> GetClassificationAsync (string guid, string classificationName, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasClassification>> GetClassificationAsync(string guid, string classificationName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassificationAsync (guid As String, classificationName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasClassification))" /> <MemberSignature Language="F#" Value="abstract member GetClassificationAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>>
override this.GetClassificationAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>>" Usage="entity.GetClassificationAsync (guid, classificationName, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassification>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get classification for a given entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetClassificationAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasClassification> response = await client.GetClassificationAsync("9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", "MICROSOFT.PERSONAL.DATE_OF_BIRTH"); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetClassifications (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetClassifications(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassifications(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifications (guid As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetClassifications : string * Azure.RequestContext -> Azure.Response
override this.GetClassifications : string * Azure.RequestContext -> Azure.Response" Usage="entity.GetClassifications (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List classifications for a given entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetClassifications(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetClassifications and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetClassifications("67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications> GetClassifications (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasClassifications> GetClassifications(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassifications(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassifications (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasClassifications)" /> <MemberSignature Language="F#" Value="abstract member GetClassifications : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>
override this.GetClassifications : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>" Usage="entity.GetClassifications (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List classifications for a given entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasClassifications> response = client.GetClassifications("67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd"); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetClassificationsAsync (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetClassificationsAsync(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassificationsAsync (guid As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetClassificationsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetClassificationsAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetClassificationsAsync (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] List classifications for a given entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationsAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetClassificationsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetClassificationsAsync("67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>> GetClassificationsAsync (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasClassifications>> GetClassificationsAsync(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetClassificationsAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetClassificationsAsync (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasClassifications))" /> <MemberSignature Language="F#" Value="abstract member GetClassificationsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>>
override this.GetClassificationsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>>" Usage="entity.GetClassificationsAsync (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasClassifications>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> List classifications for a given entity represented by a GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasClassifications> response = await client.GetClassificationsAsync("67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd"); ]]></code></example> </Docs> </Member> <Member MemberName="GetEntity"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetEntity (string guid, bool? minExtInfo, bool? ignoreRelationships, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetEntity(string guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetEntity(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEntity (guid As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetEntity : string * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetEntity : string * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="entity.GetEntity (guid, minExtInfo, ignoreRelationships, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get complete definition of an entity given its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetEntity(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetEntity and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetEntity("5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", true, null, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetEntity"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo> GetEntity (string guid, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo> GetEntity(string guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetEntity(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEntity (guid As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasEntityWithExtInfo)" /> <MemberSignature Language="F#" Value="abstract member GetEntity : string * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>
override this.GetEntity : string * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>" Usage="entity.GetEntity (guid, minExtInfo, ignoreRelationships, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get complete definition of an entity given its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetEntity. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityWithExtInfo> response = client.GetEntity("5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb"); ]]></code></example> </Docs> </Member> <Member MemberName="GetEntityAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetEntityAsync (string guid, bool? minExtInfo, bool? ignoreRelationships, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetEntityAsync(string guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetEntityAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEntityAsync (guid As String, minExtInfo As Nullable(Of Boolean), ignoreRelationships As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetEntityAsync : string * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetEntityAsync : string * Nullable<bool> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetEntityAsync (guid, minExtInfo, ignoreRelationships, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get complete definition of an entity given its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetEntityAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetEntityAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetEntityAsync("5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", true, null, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetEntityAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>> GetEntityAsync (string guid, bool? minExtInfo = default, bool? ignoreRelationships = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>> GetEntityAsync(string guid, valuetype System.Nullable`1<bool> minExtInfo, valuetype System.Nullable`1<bool> ignoreRelationships, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetEntityAsync(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEntityAsync (guid As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntityWithExtInfo))" /> <MemberSignature Language="F#" Value="abstract member GetEntityAsync : string * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>>
override this.GetEntityAsync : string * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>>" Usage="entity.GetEntityAsync (guid, minExtInfo, ignoreRelationships, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="minExtInfo" Type="System.Nullable<System.Boolean>" /> <Parameter Name="ignoreRelationships" Type="System.Nullable<System.Boolean>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="minExtInfo"> Whether to return minimal information for referred entities. </param> <param name="ignoreRelationships"> Whether to ignore relationship attributes. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get complete definition of an entity given its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetEntityAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityWithExtInfo> response = await client.GetEntityAsync("5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb"); ]]></code></example> </Docs> </Member> <Member MemberName="GetHeader"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetHeader (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetHeader(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetHeader(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetHeader (guid As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetHeader : string * Azure.RequestContext -> Azure.Response
override this.GetHeader : string * Azure.RequestContext -> Azure.Response" Usage="entity.GetHeader (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get entity header given its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetHeader(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetHeader and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.GetHeader("9fb74c11-ac48-4650-95bc-760665c5bd92", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetHeader"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader> GetHeader (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityHeader> GetHeader(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetHeader(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetHeader (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasEntityHeader)" /> <MemberSignature Language="F#" Value="abstract member GetHeader : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>
override this.GetHeader : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>" Usage="entity.GetHeader (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get entity header given its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetHeader. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityHeader> response = client.GetHeader("9fb74c11-ac48-4650-95bc-760665c5bd92"); ]]></code></example> </Docs> </Member> <Member MemberName="GetHeaderAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetHeaderAsync (string guid, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetHeaderAsync(string guid, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetHeaderAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetHeaderAsync (guid As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetHeaderAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetHeaderAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.GetHeaderAsync (guid, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get entity header given its GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.GetHeaderAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetHeaderAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.GetHeaderAsync("9fb74c11-ac48-4650-95bc-760665c5bd92", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetHeaderAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>> GetHeaderAsync (string guid, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.AtlasEntityHeader>> GetHeaderAsync(string guid, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.GetHeaderAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetHeaderAsync (guid As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasEntityHeader))" /> <MemberSignature Language="F#" Value="abstract member GetHeaderAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>>
override this.GetHeaderAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>>" Usage="entity.GetHeaderAsync (guid, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasEntityHeader>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get entity header given its GUID. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetHeaderAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<AtlasEntityHeader> response = await client.GetHeaderAsync("9fb74c11-ac48-4650-95bc-760665c5bd92"); ]]></code></example> </Docs> </Member> <Member MemberName="ImportBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult> ImportBusinessMetadata (Azure.Analytics.Purview.DataMap.BusinessMetadataOptions body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.BulkImportResult> ImportBusinessMetadata(class Azure.Analytics.Purview.DataMap.BusinessMetadataOptions body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadata(Azure.Analytics.Purview.DataMap.BusinessMetadataOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportBusinessMetadata (body As BusinessMetadataOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BulkImportResult)" /> <MemberSignature Language="F#" Value="abstract member ImportBusinessMetadata : Azure.Analytics.Purview.DataMap.BusinessMetadataOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>
override this.ImportBusinessMetadata : Azure.Analytics.Purview.DataMap.BusinessMetadataOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>" Usage="entity.ImportBusinessMetadata (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.BusinessMetadataOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Upload the file for creating Business Metadata in BULK. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call ImportBusinessMetadata. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); BusinessMetadataOptions body = null; Response<BulkImportResult> response = client.ImportBusinessMetadata(body); ]]></code></example> </Docs> </Member> <Member MemberName="ImportBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult> ImportBusinessMetadata (BinaryData file, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.BulkImportResult> ImportBusinessMetadata(class System.BinaryData file, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadata(System.BinaryData,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportBusinessMetadata (file As BinaryData, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BulkImportResult)" /> <MemberSignature Language="F#" Value="abstract member ImportBusinessMetadata : BinaryData * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>
override this.ImportBusinessMetadata : BinaryData * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>" Usage="entity.ImportBusinessMetadata (file, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="file" Type="System.BinaryData" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="file"> InputStream of file. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Upload the file for creating Business Metadata in BULK. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="file" /> is null. </exception> </Docs> </Member> <Member MemberName="ImportBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response ImportBusinessMetadata (Azure.Core.RequestContent content, string contentType, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response ImportBusinessMetadata(class Azure.Core.RequestContent content, string contentType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadata(Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportBusinessMetadata (content As RequestContent, contentType As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member ImportBusinessMetadata : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.ImportBusinessMetadata : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.ImportBusinessMetadata (content, contentType, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="contentType" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="contentType"> The content type for the operation. Always multipart/form-data for this operation. Allowed values: "multipart/form-data". </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Upload the file for creating Business Metadata in BULK <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadata(Azure.Analytics.Purview.DataMap.BusinessMetadataOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ImportBusinessMetadata and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = null; Response response = client.ImportBusinessMetadata(content, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="ImportBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>> ImportBusinessMetadataAsync (Azure.Analytics.Purview.DataMap.BusinessMetadataOptions body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.BulkImportResult>> ImportBusinessMetadataAsync(class Azure.Analytics.Purview.DataMap.BusinessMetadataOptions body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadataAsync(Azure.Analytics.Purview.DataMap.BusinessMetadataOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportBusinessMetadataAsync (body As BusinessMetadataOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BulkImportResult))" /> <MemberSignature Language="F#" Value="abstract member ImportBusinessMetadataAsync : Azure.Analytics.Purview.DataMap.BusinessMetadataOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>>
override this.ImportBusinessMetadataAsync : Azure.Analytics.Purview.DataMap.BusinessMetadataOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>>" Usage="entity.ImportBusinessMetadataAsync (body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.BulkImportResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.BusinessMetadataOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Upload the file for creating Business Metadata in BULK. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="body" /> is null. </exception> <example> This sample shows how to call ImportBusinessMetadataAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); BusinessMetadataOptions body = null; Response<BulkImportResult> response = await client.ImportBusinessMetadataAsync(body); ]]></code></example> </Docs> </Member> <Member MemberName="ImportBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> ImportBusinessMetadataAsync (Azure.Core.RequestContent content, string contentType, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> ImportBusinessMetadataAsync(class Azure.Core.RequestContent content, string contentType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadataAsync(Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportBusinessMetadataAsync (content As RequestContent, contentType As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member ImportBusinessMetadataAsync : Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ImportBusinessMetadataAsync : Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.ImportBusinessMetadataAsync (content, contentType, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="contentType" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="content"> The content to send as the body of the request. </param> <param name="contentType"> The content type for the operation. Always multipart/form-data for this operation. Allowed values: "multipart/form-data". </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Upload the file for creating Business Metadata in BULK <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.ImportBusinessMetadataAsync(Azure.Analytics.Purview.DataMap.BusinessMetadataOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ImportBusinessMetadataAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = null; Response response = await client.ImportBusinessMetadataAsync(content, null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="MoveEntitiesToCollection"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> MoveEntitiesToCollection (string collectionId, Azure.Analytics.Purview.DataMap.MoveEntitiesConfig body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> MoveEntitiesToCollection(string collectionId, class Azure.Analytics.Purview.DataMap.MoveEntitiesConfig body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollection(System.String,Azure.Analytics.Purview.DataMap.MoveEntitiesConfig,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MoveEntitiesToCollection (collectionId As String, body As MoveEntitiesConfig, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member MoveEntitiesToCollection : string * Azure.Analytics.Purview.DataMap.MoveEntitiesConfig * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.MoveEntitiesToCollection : string * Azure.Analytics.Purview.DataMap.MoveEntitiesConfig * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.MoveEntitiesToCollection (collectionId, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.MoveEntitiesConfig" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="collectionId"> The collection where entities will be moved to. </param> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Move existing entities to the target collection. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="collectionId" /> or <paramref name="body" /> is null. </exception> <example> This sample shows how to call MoveEntitiesToCollection. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); MoveEntitiesConfig body = new MoveEntitiesConfig { EntityGuids = { "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" }, }; Response<EntityMutationResult> response = client.MoveEntitiesToCollection("ExampleNewCollection", body); ]]></code></example> </Docs> </Member> <Member MemberName="MoveEntitiesToCollection"> <MemberSignature Language="C#" Value="public virtual Azure.Response MoveEntitiesToCollection (string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response MoveEntitiesToCollection(string collectionId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollection(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MoveEntitiesToCollection (collectionId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member MoveEntitiesToCollection : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.MoveEntitiesToCollection : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.MoveEntitiesToCollection (collectionId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="collectionId"> The collection where entities will be moved to. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Move existing entities to the target collection. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollection(System.String,Azure.Analytics.Purview.DataMap.MoveEntitiesConfig,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="collectionId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call MoveEntitiesToCollection and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { entityGuids = new object[] { "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" }, }); Response response = client.MoveEntitiesToCollection("ExampleNewCollection", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="MoveEntitiesToCollectionAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> MoveEntitiesToCollectionAsync (string collectionId, Azure.Analytics.Purview.DataMap.MoveEntitiesConfig body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> MoveEntitiesToCollectionAsync(string collectionId, class Azure.Analytics.Purview.DataMap.MoveEntitiesConfig body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollectionAsync(System.String,Azure.Analytics.Purview.DataMap.MoveEntitiesConfig,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MoveEntitiesToCollectionAsync (collectionId As String, body As MoveEntitiesConfig, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member MoveEntitiesToCollectionAsync : string * Azure.Analytics.Purview.DataMap.MoveEntitiesConfig * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.MoveEntitiesToCollectionAsync : string * Azure.Analytics.Purview.DataMap.MoveEntitiesConfig * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.MoveEntitiesToCollectionAsync (collectionId, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.MoveEntitiesConfig" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="collectionId"> The collection where entities will be moved to. </param> <param name="body"> Body parameter. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Move existing entities to the target collection. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="collectionId" /> or <paramref name="body" /> is null. </exception> <example> This sample shows how to call MoveEntitiesToCollectionAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); MoveEntitiesConfig body = new MoveEntitiesConfig { EntityGuids = { "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" }, }; Response<EntityMutationResult> response = await client.MoveEntitiesToCollectionAsync("ExampleNewCollection", body); ]]></code></example> </Docs> </Member> <Member MemberName="MoveEntitiesToCollectionAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> MoveEntitiesToCollectionAsync (string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> MoveEntitiesToCollectionAsync(string collectionId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollectionAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MoveEntitiesToCollectionAsync (collectionId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member MoveEntitiesToCollectionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.MoveEntitiesToCollectionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.MoveEntitiesToCollectionAsync (collectionId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="collectionId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="collectionId"> The collection where entities will be moved to. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Move existing entities to the target collection. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.MoveEntitiesToCollectionAsync(System.String,Azure.Analytics.Purview.DataMap.MoveEntitiesConfig,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="collectionId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call MoveEntitiesToCollectionAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(apiVersion: "2023-09-01"); using RequestContent content = RequestContent.Create(new { entityGuids = new object[] { "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" }, }); Response response = await client.MoveEntitiesToCollectionAsync("ExampleNewCollection", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="Pipeline"> <MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" /> <MemberSignature Language="DocId" Value="P:Azure.Analytics.Purview.DataMap.Entity.Pipeline" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" /> <MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Analytics.Purview.DataMap.Entity.Pipeline" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType> </ReturnValue> <Docs> <summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RemoveBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBusinessMetadata (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBusinessMetadata(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadata(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadata (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadata : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RemoveBusinessMetadata : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveBusinessMetadata (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Remove business metadata from an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadata(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBusinessMetadata. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { myBizMetadata1 = new { bizAttr1 = "myBizMetaData1.bizAttr1", }, }); Response response = client.RemoveBusinessMetadata("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadata"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBusinessMetadata (string guid, System.Collections.Generic.IDictionary<string,System.Collections.Generic.IDictionary<string,BinaryData>> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBusinessMetadata(string guid, class System.Collections.Generic.IDictionary`2<string, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData>> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadata(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadata (guid As String, body As IDictionary(Of String, IDictionary(Of String, BinaryData)), Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadata : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * System.Threading.CancellationToken -> Azure.Response
override this.RemoveBusinessMetadata : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.RemoveBusinessMetadata (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IDictionary<System.String,System.BinaryData>>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> Business metadata payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Remove business metadata from an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBusinessMetadata. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveBusinessMetadata("02c373fe-2823-4be3-97fa-55180a9faa06", new Dictionary<string, IDictionary<string, BinaryData>> { ["myBizMetadata1"] = new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("myBizMetaData1.bizAttr1") } }); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBusinessMetadataAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBusinessMetadataAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBusinessMetadataAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveBusinessMetadataAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Remove business metadata from an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBusinessMetadataAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { myBizMetadata1 = new { bizAttr1 = "myBizMetaData1.bizAttr1", }, }); Response response = await client.RemoveBusinessMetadataAsync("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBusinessMetadataAsync (string guid, System.Collections.Generic.IDictionary<string,System.Collections.Generic.IDictionary<string,BinaryData>> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBusinessMetadataAsync(string guid, class System.Collections.Generic.IDictionary`2<string, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData>> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData}},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAsync (guid As String, body As IDictionary(Of String, IDictionary(Of String, BinaryData)), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAsync : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBusinessMetadataAsync : string * System.Collections.Generic.IDictionary<string, System.Collections.Generic.IDictionary<string, BinaryData>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveBusinessMetadataAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IDictionary<System.String,System.BinaryData>>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> Business metadata payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Remove business metadata from an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBusinessMetadataAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveBusinessMetadataAsync("02c373fe-2823-4be3-97fa-55180a9faa06", new Dictionary<string, IDictionary<string, BinaryData>> { ["myBizMetadata1"] = new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("myBizMetaData1.bizAttr1") } }); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBusinessMetadataAttributes (string guid, string businessMetadataName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBusinessMetadataAttributes(string guid, string businessMetadataName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributes(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAttributes (guid As String, businessMetadataName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAttributes : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RemoveBusinessMetadataAttributes : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveBusinessMetadataAttributes (guid, businessMetadataName, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete business metadata attributes from an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributes(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBusinessMetadataAttributes. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { bizAttr1 = "bizAttr1", }); Response response = client.RemoveBusinessMetadataAttributes("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAttributes"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBusinessMetadataAttributes (string guid, string businessMetadataName, System.Collections.Generic.IDictionary<string,BinaryData> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBusinessMetadataAttributes(string guid, string businessMetadataName, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributes(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAttributes (guid As String, businessMetadataName As String, body As IDictionary(Of String, BinaryData), Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAttributes : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> Azure.Response
override this.RemoveBusinessMetadataAttributes : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.RemoveBusinessMetadataAttributes (guid, businessMetadataName, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.BinaryData>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="body"> Business metadata attribute payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete business metadata attributes from an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBusinessMetadataAttributes. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveBusinessMetadataAttributes("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("bizAttr1") }); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBusinessMetadataAttributesAsync (string guid, string businessMetadataName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBusinessMetadataAttributesAsync(string guid, string businessMetadataName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributesAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAttributesAsync (guid As String, businessMetadataName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAttributesAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBusinessMetadataAttributesAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveBusinessMetadataAttributesAsync (guid, businessMetadataName, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete business metadata attributes from an entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributesAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBusinessMetadataAttributesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { bizAttr1 = "bizAttr1", }); Response response = await client.RemoveBusinessMetadataAttributesAsync("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBusinessMetadataAttributesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBusinessMetadataAttributesAsync (string guid, string businessMetadataName, System.Collections.Generic.IDictionary<string,BinaryData> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBusinessMetadataAttributesAsync(string guid, string businessMetadataName, class System.Collections.Generic.IDictionary`2<string, class System.BinaryData> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveBusinessMetadataAttributesAsync(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.BinaryData},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBusinessMetadataAttributesAsync (guid As String, businessMetadataName As String, body As IDictionary(Of String, BinaryData), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBusinessMetadataAttributesAsync : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBusinessMetadataAttributesAsync : string * string * System.Collections.Generic.IDictionary<string, BinaryData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveBusinessMetadataAttributesAsync (guid, businessMetadataName, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="businessMetadataName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IDictionary<System.String,System.BinaryData>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="businessMetadataName"> BusinessMetadata name. </param> <param name="body"> Business metadata attribute payload. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete business metadata attributes from an entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="businessMetadataName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="businessMetadataName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBusinessMetadataAttributesAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveBusinessMetadataAttributesAsync("02c373fe-2823-4be3-97fa-55180a9faa06", "myBizMetaData1", new Dictionary<string, BinaryData> { ["bizAttr1"] = BinaryData.FromObjectAsJson("bizAttr1") }); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveClassification"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveClassification (string guid, string classificationName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveClassification(string guid, string classificationName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveClassification(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveClassification (guid As String, classificationName As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveClassification : string * string * Azure.RequestContext -> Azure.Response
override this.RemoveClassification : string * string * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveClassification (guid, classificationName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a given classification from an existing entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveClassification. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveClassification("cc0730ba-9b30-41f0-6953-559d17626d2b", "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveClassificationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveClassificationAsync (string guid, string classificationName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveClassificationAsync(string guid, string classificationName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveClassificationAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveClassificationAsync (guid As String, classificationName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveClassificationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveClassificationAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveClassificationAsync (guid, classificationName, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="classificationName"> The name of the classification. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a given classification from an existing entity represented by a GUID. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveClassificationAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveClassificationAsync("cc0730ba-9b30-41f0-6953-559d17626d2b", "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveClassificationByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveClassificationByUniqueAttribute (string typeName, string classificationName, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveClassificationByUniqueAttribute(string typeName, string classificationName, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveClassificationByUniqueAttribute(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveClassificationByUniqueAttribute (typeName As String, classificationName As String, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveClassificationByUniqueAttribute : string * string * string * Azure.RequestContext -> Azure.Response
override this.RemoveClassificationByUniqueAttribute : string * string * string * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveClassificationByUniqueAttribute (typeName, classificationName, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="classificationName"> The name of the classification. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a given classification from an entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveClassificationByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveClassificationByUniqueAttribute("column", "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveClassificationByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveClassificationByUniqueAttributeAsync (string typeName, string classificationName, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveClassificationByUniqueAttributeAsync(string typeName, string classificationName, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveClassificationByUniqueAttributeAsync(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveClassificationByUniqueAttributeAsync (typeName As String, classificationName As String, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveClassificationByUniqueAttributeAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveClassificationByUniqueAttributeAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveClassificationByUniqueAttributeAsync (typeName, classificationName, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="classificationName" Type="System.String" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="classificationName"> The name of the classification. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete a given classification from an entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="classificationName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> or <paramref name="classificationName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveClassificationByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveClassificationByUniqueAttributeAsync("column", "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabels"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveLabels (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveLabels(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabels(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabels (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveLabels : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RemoveLabels : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveLabels (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete given labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabels(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveLabels. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = client.RemoveLabels("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabels"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveLabels (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveLabels(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabels(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabels (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveLabels : string * seq<string> * System.Threading.CancellationToken -> Azure.Response
override this.RemoveLabels : string * seq<string> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.RemoveLabels (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be deleted. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete given labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveLabels. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveLabels("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveLabelsAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveLabelsAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveLabelsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveLabelsAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete given labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveLabelsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = await client.RemoveLabelsAsync("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveLabelsAsync (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveLabelsAsync(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsAsync (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveLabelsAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveLabelsAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be deleted. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete given labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveLabelsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveLabelsAsync("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveLabelsByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveLabelsByUniqueAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.RemoveLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.RemoveLabelsByUniqueAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1" }); Response response = client.RemoveLabelsByUniqueAttribute("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveLabelsByUniqueAttribute (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveLabelsByUniqueAttribute(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsByUniqueAttribute (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response
override this.RemoveLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response" Usage="entity.RemoveLabelsByUniqueAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be deleted. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.RemoveLabelsByUniqueAttribute("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveLabelsByUniqueAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveLabelsByUniqueAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsByUniqueAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveLabelsByUniqueAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1" }); Response response = await client.RemoveLabelsByUniqueAttributeAsync("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveLabelsByUniqueAttributeAsync (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveLabelsByUniqueAttributeAsync(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.RemoveLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveLabelsByUniqueAttributeAsync (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.RemoveLabelsByUniqueAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be deleted. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.RemoveLabelsByUniqueAttributeAsync("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabels"> <MemberSignature Language="C#" Value="public virtual Azure.Response SetLabels (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response SetLabels(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabels(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabels (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member SetLabels : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.SetLabels : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.SetLabels (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.SetLabels(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SetLabels. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = client.SetLabels("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabels"> <MemberSignature Language="C#" Value="public virtual Azure.Response SetLabels (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response SetLabels(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabels(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabels (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member SetLabels : string * seq<string> * System.Threading.CancellationToken -> Azure.Response
override this.SetLabels : string * seq<string> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.SetLabels (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be set to the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call SetLabels. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.SetLabels("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> SetLabelsAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> SetLabelsAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member SetLabelsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SetLabelsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.SetLabelsAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set labels to a given entity. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SetLabelsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = await client.SetLabelsAsync("02c373fe-2823-4be3-97fa-55180a9faa06", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> SetLabelsAsync (string guid, System.Collections.Generic.IEnumerable<string> body = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> SetLabelsAsync(string guid, class System.Collections.Generic.IEnumerable`1<string> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsAsync (guid As String, Optional body As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member SetLabelsAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.SetLabelsAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.SetLabelsAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> set of labels to be set to the entity. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set labels to a given entity. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call SetLabelsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.SetLabelsAsync("02c373fe-2823-4be3-97fa-55180a9faa06"); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response SetLabelsByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response SetLabelsByUniqueAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member SetLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.SetLabelsByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.SetLabelsByUniqueAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SetLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = client.SetLabelsByUniqueAttribute("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response SetLabelsByUniqueAttribute (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response SetLabelsByUniqueAttribute(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttribute(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsByUniqueAttribute (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member SetLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response
override this.SetLabelsByUniqueAttribute : string * seq<string> * string * System.Threading.CancellationToken -> Azure.Response" Usage="entity.SetLabelsByUniqueAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be set. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call SetLabelsByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.SetLabelsByUniqueAttribute("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> SetLabelsByUniqueAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> SetLabelsByUniqueAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsByUniqueAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member SetLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SetLabelsByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.SetLabelsByUniqueAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SetLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { "label1", "label2" }); Response response = await client.SetLabelsByUniqueAttributeAsync("Asset", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="SetLabelsByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> SetLabelsByUniqueAttributeAsync (string typeName, System.Collections.Generic.IEnumerable<string> body = default, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> SetLabelsByUniqueAttributeAsync(string typeName, class System.Collections.Generic.IEnumerable`1<string> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.SetLabelsByUniqueAttributeAsync(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SetLabelsByUniqueAttributeAsync (typeName As String, Optional body As IEnumerable(Of String) = Nothing, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member SetLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.SetLabelsByUniqueAttributeAsync : string * seq<string> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.SetLabelsByUniqueAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> set of labels to be set. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call SetLabelsByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.SetLabelsByUniqueAttributeAsync("Asset"); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateAttributeById"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateAttributeById (string guid, string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateAttributeById(string guid, string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeById(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAttributeById (guid As String, name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateAttributeById : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateAttributeById : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.UpdateAttributeById (guid, name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="name"> The name of the attribute. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeById(System.String,System.String,System.BinaryData,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateAttributeById and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create("ExampleNewName"); Response response = client.UpdateAttributeById("394d9a03-912e-483b-bbd2-bedee1a69798", "ExampleName", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateAttributeById"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> UpdateAttributeById (string guid, string name, BinaryData body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> UpdateAttributeById(string guid, string name, class System.BinaryData body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeById(System.String,System.String,System.BinaryData,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAttributeById (guid As String, name As String, body As BinaryData, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member UpdateAttributeById : string * string * BinaryData * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.UpdateAttributeById : string * string * BinaryData * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.UpdateAttributeById (guid, name, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="name" Type="System.String" /> <Parameter Name="body" Type="System.BinaryData" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="name"> The name of the attribute. </param> <param name="body"> The value of the attribute. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="name" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateAttributeById. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = client.UpdateAttributeById("394d9a03-912e-483b-bbd2-bedee1a69798", "ExampleName", BinaryData.FromObjectAsJson("ExampleNewName")); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateAttributeByIdAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateAttributeByIdAsync (string guid, string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateAttributeByIdAsync(string guid, string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeByIdAsync(System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAttributeByIdAsync (guid As String, name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateAttributeByIdAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateAttributeByIdAsync : string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.UpdateAttributeByIdAsync (guid, name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="name"> The name of the attribute. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeByIdAsync(System.String,System.String,System.BinaryData,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateAttributeByIdAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create("ExampleNewName"); Response response = await client.UpdateAttributeByIdAsync("394d9a03-912e-483b-bbd2-bedee1a69798", "ExampleName", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateAttributeByIdAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> UpdateAttributeByIdAsync (string guid, string name, BinaryData body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> UpdateAttributeByIdAsync(string guid, string name, class System.BinaryData body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateAttributeByIdAsync(System.String,System.String,System.BinaryData,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateAttributeByIdAsync (guid As String, name As String, body As BinaryData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member UpdateAttributeByIdAsync : string * string * BinaryData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.UpdateAttributeByIdAsync : string * string * BinaryData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.UpdateAttributeByIdAsync (guid, name, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="name" Type="System.String" /> <Parameter Name="body" Type="System.BinaryData" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="name"> The name of the attribute. </param> <param name="body"> The value of the attribute. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" />, <paramref name="name" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateAttributeByIdAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response<EntityMutationResult> response = await client.UpdateAttributeByIdAsync("394d9a03-912e-483b-bbd2-bedee1a69798", "ExampleName", BinaryData.FromObjectAsJson("ExampleNewName")); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult> UpdateByUniqueAttribute (string typeName, Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult> UpdateByUniqueAttribute(string typeName, class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttribute(System.String,Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateByUniqueAttribute (typeName As String, body As AtlasEntityWithExtInfo, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EntityMutationResult)" /> <MemberSignature Language="F#" Value="abstract member UpdateByUniqueAttribute : string * Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>
override this.UpdateByUniqueAttribute : string * Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>" Usage="entity.UpdateByUniqueAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> Body parameter. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateByUniqueAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["createTime"] = BinaryData.FromObjectAsJson(0), ["name"] = BinaryData.FromObjectAsJson("ExampleNewName") }, TypeName = "azure_storage_account", LastModifiedTS = "1", CreateTime = default, CreatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", Guid = "dc507ccf-0c57-4165-9327-f37b0d13fda0", RelationshipAttributes = { ["services"] = BinaryData.FromObjectAsJson(Array.Empty<object>()), ["meanings"] = BinaryData.FromObjectAsJson(Array.Empty<object>()) }, Status = EntityStatus.Active, UpdateTime = default, UpdatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", Version = 0L, }, }; Response<EntityMutationResult> response = client.UpdateByUniqueAttribute("azure_storage_account", body); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateByUniqueAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateByUniqueAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateByUniqueAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateByUniqueAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.UpdateByUniqueAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.UpdateByUniqueAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttribute(System.String,Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateByUniqueAttribute and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { entity = new { createdBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", guid = "dc507ccf-0c57-4165-9327-f37b0d13fda0", relationshipAttributes = new { services = Array.Empty<object>(), meanings = Array.Empty<object>(), }, status = "ACTIVE", updatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", lastModifiedTS = "1", version = 0L, attributes = new { owner = "ExampleOwner", qualifiedName = "https://exampleaccount.core.windows.net", createTime = 0, name = "ExampleNewName", }, typeName = "azure_storage_account", }, referredEntities = new object(), }); Response response = client.UpdateByUniqueAttribute("azure_storage_account", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>> UpdateByUniqueAttributeAsync (string typeName, Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Analytics.Purview.DataMap.EntityMutationResult>> UpdateByUniqueAttributeAsync(string typeName, class Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttributeAsync(System.String,Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateByUniqueAttributeAsync (typeName As String, body As AtlasEntityWithExtInfo, Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EntityMutationResult))" /> <MemberSignature Language="F#" Value="abstract member UpdateByUniqueAttributeAsync : string * Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>
override this.UpdateByUniqueAttributeAsync : string * Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>>" Usage="entity.UpdateByUniqueAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.EntityMutationResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> Body parameter. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateByUniqueAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); AtlasEntityWithExtInfo body = new AtlasEntityWithExtInfo { ReferredEntities = { }, Entity = new AtlasEntity { Attributes = { ["owner"] = BinaryData.FromObjectAsJson("ExampleOwner"), ["qualifiedName"] = BinaryData.FromObjectAsJson("https://exampleaccount.core.windows.net"), ["createTime"] = BinaryData.FromObjectAsJson(0), ["name"] = BinaryData.FromObjectAsJson("ExampleNewName") }, TypeName = "azure_storage_account", LastModifiedTS = "1", CreateTime = default, CreatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", Guid = "dc507ccf-0c57-4165-9327-f37b0d13fda0", RelationshipAttributes = { ["services"] = BinaryData.FromObjectAsJson(Array.Empty<object>()), ["meanings"] = BinaryData.FromObjectAsJson(Array.Empty<object>()) }, Status = EntityStatus.Active, UpdateTime = default, UpdatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", Version = 0L, }, }; Response<EntityMutationResult> response = await client.UpdateByUniqueAttributeAsync("azure_storage_account", body); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateByUniqueAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateByUniqueAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateByUniqueAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateByUniqueAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateByUniqueAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.UpdateByUniqueAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateByUniqueAttributeAsync(System.String,Azure.Analytics.Purview.DataMap.AtlasEntityWithExtInfo,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateByUniqueAttributeAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new { entity = new { createdBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", guid = "dc507ccf-0c57-4165-9327-f37b0d13fda0", relationshipAttributes = new { services = Array.Empty<object>(), meanings = Array.Empty<object>(), }, status = "ACTIVE", updatedBy = "8c062c84-5d25-449f-a990-9d8ab70b8ec7", lastModifiedTS = "1", version = 0L, attributes = new { owner = "ExampleOwner", qualifiedName = "https://exampleaccount.core.windows.net", createTime = 0, name = "ExampleNewName", }, typeName = "azure_storage_account", }, referredEntities = new object(), }); Response response = await client.UpdateByUniqueAttributeAsync("azure_storage_account", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateClassifications (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateClassifications(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassifications(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassifications (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateClassifications : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateClassifications : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="entity.UpdateClassifications (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update classifications to an existing entity represented by a guid. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassifications(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", entityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", }, new { typeName = "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", entityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", } }); Response response = client.UpdateClassifications("45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassifications"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateClassifications (string guid, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateClassifications(string guid, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassifications(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassifications (guid As String, body As IEnumerable(Of AtlasClassification), Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response
override this.UpdateClassifications : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * System.Threading.CancellationToken -> Azure.Response" Usage="entity.UpdateClassifications (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> An array of classifications to be updated. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update classifications to an existing entity represented by a guid. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateClassifications. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.UpdateClassifications("45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", EntityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", EntityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", } }); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateClassificationsAsync (string guid, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateClassificationsAsync(string guid, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsAsync (guid As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="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>" Usage="entity.UpdateClassificationsAsync (guid, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update classifications to an existing entity represented by a guid. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", entityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", }, new { typeName = "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", entityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", } }); Response response = await client.UpdateClassificationsAsync("45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateClassificationsAsync(string guid, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsAsync (guid As String, body As IEnumerable(Of AtlasClassification), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="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>" Usage="entity.UpdateClassificationsAsync (guid, body, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="guid" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="guid"> The globally unique identifier of the entity. </param> <param name="body"> An array of classifications to be updated. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update classifications to an existing entity represented by a guid. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="guid" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="guid" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateClassificationsAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.UpdateClassificationsAsync("45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", EntityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", EntityGuid = "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", } }); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsUniqueByAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateClassificationsUniqueByAttribute (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateClassificationsUniqueByAttribute(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttribute(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsUniqueByAttribute (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateClassificationsUniqueByAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.UpdateClassificationsUniqueByAttribute : string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response" Usage="entity.UpdateClassificationsUniqueByAttribute (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update classification on an entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttribute(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateClassificationsUniqueByAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); Response response = client.UpdateClassificationsUniqueByAttribute("azure_storage_account", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsUniqueByAttribute"> <MemberSignature Language="C#" Value="public virtual Azure.Response UpdateClassificationsUniqueByAttribute (string typeName, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response UpdateClassificationsUniqueByAttribute(string typeName, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttribute(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsUniqueByAttribute (typeName As String, body As IEnumerable(Of AtlasClassification), Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member UpdateClassificationsUniqueByAttribute : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> Azure.Response
override this.UpdateClassificationsUniqueByAttribute : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> Azure.Response" Usage="entity.UpdateClassificationsUniqueByAttribute (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> An array of classification to be updated. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update classification on an entity identified by its type and unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateClassificationsUniqueByAttribute. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = client.UpdateClassificationsUniqueByAttribute("azure_storage_account", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsUniqueByAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateClassificationsUniqueByAttributeAsync (string typeName, Azure.Core.RequestContent content, string attribute = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateClassificationsUniqueByAttributeAsync(string typeName, class Azure.Core.RequestContent content, string attribute, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttributeAsync(System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsUniqueByAttributeAsync (typeName As String, content As RequestContent, Optional attribute As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateClassificationsUniqueByAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateClassificationsUniqueByAttributeAsync : string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.UpdateClassificationsUniqueByAttributeAsync (typeName, content, attribute, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="content"> The content to send as the body of the request. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Update classification on an entity identified by its type and unique attributes. <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttributeAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call UpdateClassificationsUniqueByAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); using RequestContent content = RequestContent.Create(new object[] { new { typeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new { typeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); Response response = await client.UpdateClassificationsUniqueByAttributeAsync("azure_storage_account", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="UpdateClassificationsUniqueByAttributeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> UpdateClassificationsUniqueByAttributeAsync (string typeName, System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> UpdateClassificationsUniqueByAttributeAsync(string typeName, class System.Collections.Generic.IEnumerable`1<class Azure.Analytics.Purview.DataMap.AtlasClassification> body, string attribute, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.DataMap.Entity.UpdateClassificationsUniqueByAttributeAsync(System.String,System.Collections.Generic.IEnumerable{Azure.Analytics.Purview.DataMap.AtlasClassification},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function UpdateClassificationsUniqueByAttributeAsync (typeName As String, body As IEnumerable(Of AtlasClassification), Optional attribute As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member UpdateClassificationsUniqueByAttributeAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateClassificationsUniqueByAttributeAsync : string * seq<Azure.Analytics.Purview.DataMap.AtlasClassification> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="entity.UpdateClassificationsUniqueByAttributeAsync (typeName, body, attribute, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Analytics.Purview.DataMap</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="typeName" Type="System.String" /> <Parameter Name="body" Type="System.Collections.Generic.IEnumerable<Azure.Analytics.Purview.DataMap.AtlasClassification>" /> <Parameter Name="attribute" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="typeName"> The name of the type. </param> <param name="body"> An array of classification to be updated. </param> <param name="attribute"> The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Update classification on an entity identified by its type and unique attributes. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="typeName" /> or <paramref name="body" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="typeName" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call UpdateClassificationsUniqueByAttributeAsync. <code><![CDATA[ Uri endpoint = new Uri("<endpoint>"); TokenCredential credential = new DefaultAzureCredential(); Entity client = new DataMapClient(endpoint, credential).GetEntityClient(); Response response = await client.UpdateClassificationsUniqueByAttributeAsync("azure_storage_account", new AtlasClassification[] { new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", }, new AtlasClassification { TypeName = "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", } }); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Azure.Analytics.Purview.DataMap/Entity.xml (8,265 lines of code) (raw):