Entity.AddOrUpdateBusinessMetadata Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

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

AddOrUpdateBusinessMetadata(String, RequestContent, Nullable<Boolean>, RequestContext)

Source:

Entity.cs

[Protocol Method] Add business metadata to an entity.

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

public virtual Azure.Response AddOrUpdateBusinessMetadata (string guid, Azure.Core.RequestContent content, bool? overwrite = default, Azure.RequestContext context = default);

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

Public Overridable Function AddOrUpdateBusinessMetadata (guid As String, content As RequestContent, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

guid

String

The globally unique identifier of the entity.

content

RequestContent

The content to send as the body of the request.

overwrite

Nullable<Boolean>

Whether to overwrite the existing business metadata on the entity or not, default is false.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

guid or content is null.

ArgumentException

guid 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 AddOrUpdateBusinessMetadata.

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
    {
        key = new object(),
    },
});
Response response = client.AddOrUpdateBusinessMetadata("<guid>", content);

Console.WriteLine(response.Status);

This sample shows how to call AddOrUpdateBusinessMetadata 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
    {
        key = new object(),
    },
});
Response response = client.AddOrUpdateBusinessMetadata("<guid>", content, overwrite: true);

Console.WriteLine(response.Status);

AddOrUpdateBusinessMetadata(String, IDictionary<String,IDictionary<String,BinaryData>>, Nullable<Boolean>, CancellationToken)

Source:

Entity.cs

Add business metadata to an entity.

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

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

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

Parameters

guid

String

The globally unique identifier of the entity.

body

IDictionary<String,IDictionary<String,BinaryData>>

BusinessMetadata payload.

overwrite

Nullable<Boolean>

Whether to overwrite the existing business metadata on the entity or not, default is false.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

ArgumentNullException

guid or body is null.

ArgumentException

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

Examples

This sample shows how to call AddOrUpdateBusinessMetadata.

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

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

This sample shows how to call AddOrUpdateBusinessMetadata 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 = client.AddOrUpdateBusinessMetadata("<guid>", new Dictionary<string, IDictionary<string, BinaryData>>
{
    ["key"] = new Dictionary<string, BinaryData>
    {
        ["key"] = BinaryData.FromObjectAsJson(new object())
    }
}, overwrite: true);