Glossary.PartialUpdateTerm 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
| PartialUpdateTerm(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken) |
Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term. |
| PartialUpdateTerm(String, RequestContent, Nullable<Boolean>, RequestContext) |
[Protocol Method] Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
|
PartialUpdateTerm(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)
- Source:
- Glossary.cs
Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryTerm> PartialUpdateTerm(string termId, System.Collections.Generic.IDictionary<string,string> body, bool? includeTermHierarchy = default, System.Threading.CancellationToken cancellationToken = default);abstract member PartialUpdateTerm : string * System.Collections.Generic.IDictionary<string, string> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryTerm>
override this.PartialUpdateTerm : string * System.Collections.Generic.IDictionary<string, string> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryTerm>Public Overridable Function PartialUpdateTerm (termId As String, body As IDictionary(Of String, String), Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasGlossaryTerm)Parameters
- termId
- String
The globally unique identifier for glossary term.
- body
- IDictionary<String,String>
A map containing keys as attribute names and values as corresponding attribute values to be updated.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
termId or body is null.
termId is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call PartialUpdateTerm.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
Response<AtlasGlossaryTerm> response = client.PartialUpdateTerm("54688d39-b298-4104-9e80-f2a16f44aaea", new Dictionary<string, string>
{
["longDescription"] = "Example Long Description"
});
Applies to
PartialUpdateTerm(String, RequestContent, Nullable<Boolean>, RequestContext)
- Source:
- Glossary.cs
[Protocol Method] Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler PartialUpdateTerm(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response PartialUpdateTerm(string termId, Azure.Core.RequestContent content, bool? includeTermHierarchy = default, Azure.RequestContext context = default);abstract member PartialUpdateTerm : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.PartialUpdateTerm : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.ResponsePublic Overridable Function PartialUpdateTerm (termId As String, content As RequestContent, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As ResponseParameters
- termId
- String
The globally unique identifier for glossary term.
- 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
termId or content is null.
termId 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 PartialUpdateTerm and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
using RequestContent content = RequestContent.Create(new
{
longDescription = "Example Long Description",
});
Response response = client.PartialUpdateTerm("54688d39-b298-4104-9e80-f2a16f44aaea", content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
