Entity.RemoveBusinessMetadataAttributesAsync Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

RemoveBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken)	Delete business metadata attributes from an entity.
RemoveBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)	[Protocol Method] Delete business metadata attributes from an entity. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler RemoveBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken) convenience overload with strongly typed models first.

RemoveBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken)

Source:

Entity.cs

Delete business metadata attributes from an entity.

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);

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>

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)

Parameters

guid

String

The globally unique identifier of the entity.

businessMetadataName

String

BusinessMetadata name.

body

IDictionary<String,BinaryData>

Business metadata attribute payload.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

ArgumentNullException

guid, businessMetadataName or body is null.

ArgumentException

guid or businessMetadataName is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call RemoveBusinessMetadataAttributesAsync.

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

Response response = await client.RemoveBusinessMetadataAttributesAsync("<guid>", "<businessMetadataName>", new Dictionary<string, BinaryData>
{
    ["key"] = BinaryData.FromObjectAsJson(new object())
});

This sample shows how to call RemoveBusinessMetadataAttributesAsync with all parameters.

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

Response response = await client.RemoveBusinessMetadataAttributesAsync("<guid>", "<businessMetadataName>", new Dictionary<string, BinaryData>
{
    ["key"] = BinaryData.FromObjectAsJson(new object())
});

RemoveBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)

Source:

Entity.cs

[Protocol Method] Delete business metadata attributes from an entity.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler RemoveBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken) convenience overload with strongly typed models first.

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

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>

Public Overridable Function RemoveBusinessMetadataAttributesAsync (guid As String, businessMetadataName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

guid

String

The globally unique identifier of the entity.

businessMetadataName

String

BusinessMetadata name.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

guid, businessMetadataName or content is null.

ArgumentException

guid or businessMetadataName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call RemoveBusinessMetadataAttributesAsync.

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

using RequestContent content = RequestContent.Create(new
{
    key = new object(),
});
Response response = await client.RemoveBusinessMetadataAttributesAsync("<guid>", "<businessMetadataName>", content);

Console.WriteLine(response.Status);

This sample shows how to call RemoveBusinessMetadataAttributesAsync with all parameters and request content.

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

using RequestContent content = RequestContent.Create(new
{
    key = new object(),
});
Response response = await client.RemoveBusinessMetadataAttributesAsync("<guid>", "<businessMetadataName>", content);

Console.WriteLine(response.Status);