types

Creates, updates, deletes, gets or lists a types resource.

Overview

Name	types
Type	Resource
Id	azure.purview_catalog.types

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_type_definition_headers	exec	endpoint	includeTermTemplate, type	List all type definitions returned as a list of minimal information header.
get_business_metadata_def_by_guid	exec	guid, endpoint		Get the businessMetadata definition for the given guid.
get_business_metadata_def_by_name	exec	name, endpoint		Get the businessMetadata definition by it's name (unique).
get_classification_def_by_guid	exec	guid, endpoint		Get the classification definition for the given GUID.
get_classification_def_by_name	exec	name, endpoint		Get the classification definition by its name (unique).
get_entity_definition_by_guid	exec	guid, endpoint		Get the Entity definition for the given GUID.
get_entity_definition_by_name	exec	name, endpoint		Get the entity definition by its name (unique).
get_enum_def_by_guid	exec	guid, endpoint		Get the enum definition for the given GUID.
get_enum_def_by_name	exec	name, endpoint		Get the enum definition by its name (unique).
get_relationship_def_by_guid	exec	guid, endpoint		Get the relationship definition for the given GUID.
get_relationship_def_by_name	exec	name, endpoint		Get the relationship definition by its name (unique).
get_struct_def_by_guid	exec	guid, endpoint		Get the struct definition for the given GUID.
get_struct_def_by_name	exec	name, endpoint		Get the struct definition by its name (unique).
get_type_definition_by_guid	exec	guid, endpoint		Get the type definition for the given GUID.
get_type_definition_by_name	exec	name, endpoint		Get the type definition by its name (unique).
delete_type_by_name	exec	name, endpoint		Delete API for type identified by its name.
get_all_type_definitions	exec	endpoint	includeTermTemplate, type	Get all type definitions in Atlas in bulk.
create_type_definitions	exec	endpoint		Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.
update_atlas_type_definitions	exec	endpoint		Update all types in bulk, changes detected in the type definitions would be persisted.
delete_type_definitions	exec	endpoint		Delete API for all types in bulk.
get_term_template_def_by_guid	exec	guid, endpoint		Get the term template definition for the given GUID.
get_term_template_def_by_name	exec	name, endpoint		Get the term template definition by its name (unique).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
guid	string	The globally unique identifier of the term template.
name	string	The name of the term template.
includeTermTemplate	boolean	Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template. Default value is False.
type	string	Typedef name as search filter when get typedefs. Known values are: "enum", "entity", "classification", "relationship", "struct", and "term_template". Default value is None.

Lifecycle Methods

list_type_definition_headers

List all type definitions returned as a list of minimal information header.

EXEC azure.purview_catalog.types.list_type_definition_headers 
@endpoint='{{ endpoint }}' --required, 
@includeTermTemplate={{ includeTermTemplate }}, 
@type='{{ type }}'
;

get_business_metadata_def_by_guid

Get the businessMetadata definition for the given guid.

EXEC azure.purview_catalog.types.get_business_metadata_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_business_metadata_def_by_name

Get the businessMetadata definition by it's name (unique).

EXEC azure.purview_catalog.types.get_business_metadata_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_classification_def_by_guid

Get the classification definition for the given GUID.

EXEC azure.purview_catalog.types.get_classification_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_classification_def_by_name

Get the classification definition by its name (unique).

EXEC azure.purview_catalog.types.get_classification_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_entity_definition_by_guid

Get the Entity definition for the given GUID.

EXEC azure.purview_catalog.types.get_entity_definition_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_entity_definition_by_name

Get the entity definition by its name (unique).

EXEC azure.purview_catalog.types.get_entity_definition_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_enum_def_by_guid

Get the enum definition for the given GUID.

EXEC azure.purview_catalog.types.get_enum_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_enum_def_by_name

Get the enum definition by its name (unique).

EXEC azure.purview_catalog.types.get_enum_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_relationship_def_by_guid

Get the relationship definition for the given GUID.

EXEC azure.purview_catalog.types.get_relationship_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_relationship_def_by_name

Get the relationship definition by its name (unique).

EXEC azure.purview_catalog.types.get_relationship_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_struct_def_by_guid

Get the struct definition for the given GUID.

EXEC azure.purview_catalog.types.get_struct_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_struct_def_by_name

Get the struct definition by its name (unique).

EXEC azure.purview_catalog.types.get_struct_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_type_definition_by_guid

Get the type definition for the given GUID.

EXEC azure.purview_catalog.types.get_type_definition_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_type_definition_by_name

Get the type definition by its name (unique).

EXEC azure.purview_catalog.types.get_type_definition_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_type_by_name

Delete API for type identified by its name.

EXEC azure.purview_catalog.types.delete_type_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_all_type_definitions

Get all type definitions in Atlas in bulk.

EXEC azure.purview_catalog.types.get_all_type_definitions 
@endpoint='{{ endpoint }}' --required, 
@includeTermTemplate={{ includeTermTemplate }}, 
@type='{{ type }}'
;

create_type_definitions

Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.

EXEC azure.purview_catalog.types.create_type_definitions 
@endpoint='{{ endpoint }}' --required
;

update_atlas_type_definitions

Update all types in bulk, changes detected in the type definitions would be persisted.

EXEC azure.purview_catalog.types.update_atlas_type_definitions 
@endpoint='{{ endpoint }}' --required
;

delete_type_definitions

Delete API for all types in bulk.

EXEC azure.purview_catalog.types.delete_type_definitions 
@endpoint='{{ endpoint }}' --required
;

get_term_template_def_by_guid

Get the term template definition for the given GUID.

EXEC azure.purview_catalog.types.get_term_template_def_by_guid 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_term_template_def_by_name

Get the term template definition by its name (unique).

EXEC azure.purview_catalog.types.get_term_template_def_by_name 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;