Glossary.GetDetailedAsync 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
| GetDetailedAsync(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.
|
| GetDetailedAsync(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. |
GetDetailedAsync(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 GetDetailedAsync(String, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetDetailedAsync(string glossaryId, Azure.RequestContext context);abstract member GetDetailedAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDetailedAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetDetailedAsync (glossaryId As String, context As RequestContext) As Task(Of 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
The response returned from the service.
Exceptions
glossaryId 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 GetDetailedAsync and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
Response response = await client.GetDetailedAsync("c018ddaf-7c21-4b37-a838-dae5f110c3d8", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
Applies to
GetDetailedAsync(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 System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo>> GetDetailedAsync(string glossaryId, System.Threading.CancellationToken cancellationToken = default);abstract member GetDetailedAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo>>
override this.GetDetailedAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasGlossaryExtInfo>>Public Overridable Function GetDetailedAsync (glossaryId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasGlossaryExtInfo))Parameters
- glossaryId
- String
The globally unique identifier for glossary.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
glossaryId is null.
glossaryId is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call GetDetailedAsync.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();
Response<AtlasGlossaryExtInfo> response = await client.GetDetailedAsync("c018ddaf-7c21-4b37-a838-dae5f110c3d8");
