Glossary.GetDetailed Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

Name	Description
GetDetailed(String, CancellationToken)	Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.
GetDetailed(String, RequestContext)	[Protocol Method] Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetDetailed(String, CancellationToken) convenience overload with strongly typed models first.

GetDetailed(String, CancellationToken)

Source:

Glossary.cs

Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo> GetDetailed(string glossaryId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDetailed : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo>
override this.GetDetailed : string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo>

Public Overridable Function GetDetailed (glossaryId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasGlossaryExtInfo)

Parameters

glossaryId

String

The globally unique identifier for glossary.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AtlasGlossaryExtInfo>

Exceptions

ArgumentNullException

glossaryId is null.

ArgumentException

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

Examples

This sample shows how to call GetDetailed.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response<AtlasGlossaryExtInfo> response = client.GetDetailed("c018ddaf-7c21-4b37-a838-dae5f110c3d8");

GetDetailed(String, RequestContext)

Source:

Glossary.cs

[Protocol Method] Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

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

public virtual Azure.Response GetDetailed(string glossaryId, Azure.RequestContext context);

abstract member GetDetailed : string * Azure.RequestContext -> Azure.Response
override this.GetDetailed : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDetailed (glossaryId As String, context As RequestContext) As Response

Parameters

glossaryId

String

The globally unique identifier for glossary.

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

glossaryId is null.

ArgumentException

glossaryId 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 GetDetailed and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = client.GetDetailed("c018ddaf-7c21-4b37-a838-dae5f110c3d8", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());