TypeDefinition.GetTypeDefinition 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
| GetTypeDefinition(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) |
List all type definitions in bulk. |
| GetTypeDefinition(Nullable<Boolean>, String, RequestContext) |
[Protocol Method] List all type definitions in bulk.
|
GetTypeDefinition(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)
- Source:
- TypeDefinition.cs
List all type definitions in bulk.
public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasTypesDef> GetTypeDefinition(bool? includeTermTemplate = default, Azure.Analytics.Purview.DataMap.TypeCategory? type = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetTypeDefinition : Nullable<bool> * Nullable<Azure.Analytics.Purview.DataMap.TypeCategory> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasTypesDef>
override this.GetTypeDefinition : Nullable<bool> * Nullable<Azure.Analytics.Purview.DataMap.TypeCategory> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasTypesDef>Public Overridable Function GetTypeDefinition (Optional includeTermTemplate As Nullable(Of Boolean) = Nothing, Optional type As Nullable(Of TypeCategory) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AtlasTypesDef)Parameters
Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template
- type
- Nullable<TypeCategory>
Typedef name as search filter when get typedefs.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Examples
This sample shows how to call GetTypeDefinition.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response<AtlasTypesDef> response = client.GetTypeDefinition();
This sample shows how to call GetTypeDefinition.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response<AtlasTypesDef> response = client.GetTypeDefinition();
This sample shows how to call GetTypeDefinition.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response<AtlasTypesDef> response = client.GetTypeDefinition();
Applies to
GetTypeDefinition(Nullable<Boolean>, String, RequestContext)
- Source:
- TypeDefinition.cs
[Protocol Method] List all type definitions in bulk.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetTypeDefinition(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response GetTypeDefinition(bool? includeTermTemplate, string type, Azure.RequestContext context);abstract member GetTypeDefinition : Nullable<bool> * string * Azure.RequestContext -> Azure.Response
override this.GetTypeDefinition : Nullable<bool> * string * Azure.RequestContext -> Azure.ResponsePublic Overridable Function GetTypeDefinition (includeTermTemplate As Nullable(Of Boolean), type As String, context As RequestContext) As ResponseParameters
Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template
- type
- String
Typedef name as search filter when get typedefs. Allowed values: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE".
- 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
Service returned a non-success status code.
Examples
This sample shows how to call GetTypeDefinition and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response response = client.GetTypeDefinition(true, null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
This sample shows how to call GetTypeDefinition and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response response = client.GetTypeDefinition(null, "ENUM", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
This sample shows how to call GetTypeDefinition and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
TypeDefinition client = new DataMapClient(endpoint, credential).GetTypeDefinitionClient(apiVersion: "2023-09-01");
Response response = client.GetTypeDefinition(null, "TERM_TEMPLATE", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
