Glossary.PartialUpdateAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| PartialUpdateAsync(String, RequestContent, Nullable<Boolean>, RequestContext) |
[Protocol Method] Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
|
| PartialUpdateAsync(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken) |
Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size. |
PartialUpdateAsync(String, RequestContent, Nullable<Boolean>, RequestContext)
- Source:
- Glossary.cs
[Protocol Method] Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.
So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.
Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler PartialUpdateAsync(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> PartialUpdateAsync (string glossaryId, Azure.Core.RequestContent content, bool? ignoreTermsAndCategories = default, Azure.RequestContext context = default);abstract member PartialUpdateAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.PartialUpdateAsync : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function PartialUpdateAsync (glossaryId As String, content As RequestContent, Optional ignoreTermsAndCategories As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)Parameters
- glossaryId
- String
The globally unique identifier for glossary.
- 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
The response returned from the service.
Exceptions
glossaryId or content is null.
glossaryId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call PartialUpdateAsync and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
using RequestContent content = RequestContent.Create(new
{
key = "<body>",
});
Response response = await client.PartialUpdateAsync("<glossaryId>", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
This sample shows how to call PartialUpdateAsync with all parameters and request content and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient(apiVersion: "2023-09-01");
using RequestContent content = RequestContent.Create(new
{
key = "<body>",
});
Response response = await client.PartialUpdateAsync("<glossaryId>", content, ignoreTermsAndCategories: true);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("guid").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("attributes").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("typeName").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityGuid").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("entityStatus").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString());
Console.WriteLine(result.GetProperty("longDescription").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("qualifiedName").ToString());
Console.WriteLine(result.GetProperty("shortDescription").ToString());
Console.WriteLine(result.GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("createTime").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("updateTime").ToString());
Console.WriteLine(result.GetProperty("updatedBy").ToString());
Console.WriteLine(result.GetProperty("categories")[0].GetProperty("categoryGuid").ToString());
Console.WriteLine(result.GetProperty("categories")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("categories")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result.GetProperty("categories")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("language").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("expression").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("steward").ToString());
Console.WriteLine(result.GetProperty("terms")[0].GetProperty("termGuid").ToString());
Console.WriteLine(result.GetProperty("usage").ToString());
Applies to
PartialUpdateAsync(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)
- Source:
- Glossary.cs
Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.
So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.
Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossary>> PartialUpdateAsync (string glossaryId, System.Collections.Generic.IDictionary<string,string> body, bool? ignoreTermsAndCategories = default, System.Threading.CancellationToken cancellationToken = default);abstract member PartialUpdateAsync : string * System.Collections.Generic.IDictionary<string, string> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossary>>
override this.PartialUpdateAsync : string * System.Collections.Generic.IDictionary<string, string> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossary>>Public Overridable Function PartialUpdateAsync (glossaryId As String, body As IDictionary(Of String, String), Optional ignoreTermsAndCategories As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasGlossary))Parameters
- glossaryId
- String
The globally unique identifier for glossary.
- body
- IDictionary<String,String>
A map containing keys as attribute names and values as corresponding attribute values.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
glossaryId or body is null.
glossaryId is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call PartialUpdateAsync.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
Response<AtlasGlossary> response = await client.PartialUpdateAsync("<glossaryId>", new Dictionary<string, string>
{
["key"] = "<body>"
});
This sample shows how to call PartialUpdateAsync with all parameters.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient(apiVersion: "2023-09-01");
Response<AtlasGlossary> response = await client.PartialUpdateAsync("<glossaryId>", new Dictionary<string, string>
{
["key"] = "<body>"
}, ignoreTermsAndCategories: true);
Applies to
Azure SDK for .NET