azure.purview.catalog.rest.types package¶

azure.purview.catalog.rest.types.build_get_classification_def_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the classification definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the classification.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "entityTypes": [
        "str (optional)"
    ],
    "subTypes": [
        "str (optional)"
    ],
    "superTypes": [
        "str (optional)"
    ]
}

azure.purview.catalog.rest.types.build_get_classification_def_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the classification definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the classification.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "entityTypes": [
        "str (optional)"
    ],
    "subTypes": [
        "str (optional)"
    ],
    "superTypes": [
        "str (optional)"
    ]
}

azure.purview.catalog.rest.types.build_get_entity_definition_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the Entity definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the entity.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "relationshipAttributeDefs": [
        {
            "isLegacyAttribute": "bool (optional)",
            "relationshipTypeName": "str (optional)"
        }
    ],
    "subTypes": [
        "str (optional)"
    ],
    "superTypes": [
        "str (optional)"
    ]
}

azure.purview.catalog.rest.types.build_get_entity_definition_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the entity definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the entity.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "relationshipAttributeDefs": [
        {
            "isLegacyAttribute": "bool (optional)",
            "relationshipTypeName": "str (optional)"
        }
    ],
    "subTypes": [
        "str (optional)"
    ],
    "superTypes": [
        "str (optional)"
    ]
}

azure.purview.catalog.rest.types.build_get_enum_def_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the enum definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the enum.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "defaultValue": "str (optional)",
    "elementDefs": [
        {
            "description": "str (optional)",
            "ordinal": "float (optional)",
            "value": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.types.build_get_enum_def_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the enum definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the enum.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "defaultValue": "str (optional)",
    "elementDefs": [
        {
            "description": "str (optional)",
            "ordinal": "float (optional)",
            "value": "str (optional)"
        }
    ]
}

azure.purview.catalog.rest.types.build_get_relationship_def_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the relationship definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the relationship.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "endDef1": {
        "cardinality": "str (optional)",
        "description": "str (optional)",
        "isContainer": "bool (optional)",
        "isLegacyAttribute": "bool (optional)",
        "name": "str (optional)",
        "type": "str (optional)"
    },
    "endDef2": {
        "cardinality": "str (optional)",
        "description": "str (optional)",
        "isContainer": "bool (optional)",
        "isLegacyAttribute": "bool (optional)",
        "name": "str (optional)",
        "type": "str (optional)"
    },
    "relationshipCategory": "str (optional)",
    "relationshipLabel": "str (optional)"
}

azure.purview.catalog.rest.types.build_get_relationship_def_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the relationship definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the relationship.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "endDef1": {
        "cardinality": "str (optional)",
        "description": "str (optional)",
        "isContainer": "bool (optional)",
        "isLegacyAttribute": "bool (optional)",
        "name": "str (optional)",
        "type": "str (optional)"
    },
    "endDef2": {
        "cardinality": "str (optional)",
        "description": "str (optional)",
        "isContainer": "bool (optional)",
        "isLegacyAttribute": "bool (optional)",
        "name": "str (optional)",
        "type": "str (optional)"
    },
    "relationshipCategory": "str (optional)",
    "relationshipLabel": "str (optional)"
}

azure.purview.catalog.rest.types.build_get_struct_def_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the struct definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the struct.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "attributeDefs": [
        {
            "cardinality": "str (optional)",
            "constraints": [
                {
                    "params": {
                        "str": "object (optional)"
                    },
                    "type": "str (optional)"
                }
            ],
            "defaultValue": "str (optional)",
            "description": "str (optional)",
            "includeInNotification": "bool (optional)",
            "isIndexable": "bool (optional)",
            "isOptional": "bool (optional)",
            "isUnique": "bool (optional)",
            "name": "str (optional)",
            "options": {
                "str": "str (optional)"
            },
            "typeName": "str (optional)",
            "valuesMaxCount": "int (optional)",
            "valuesMinCount": "int (optional)"
        }
    ]
}

azure.purview.catalog.rest.types.build_get_struct_def_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the struct definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the struct.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "attributeDefs": [
        {
            "cardinality": "str (optional)",
            "constraints": [
                {
                    "params": {
                        "str": "object (optional)"
                    },
                    "type": "str (optional)"
                }
            ],
            "defaultValue": "str (optional)",
            "description": "str (optional)",
            "includeInNotification": "bool (optional)",
            "isIndexable": "bool (optional)",
            "isOptional": "bool (optional)",
            "isUnique": "bool (optional)",
            "name": "str (optional)",
            "options": {
                "str": "str (optional)"
            },
            "typeName": "str (optional)",
            "valuesMaxCount": "int (optional)",
            "valuesMinCount": "int (optional)"
        }
    ]
}

azure.purview.catalog.rest.types.build_get_type_definition_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the type definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the type.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {}

azure.purview.catalog.rest.types.build_get_type_definition_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the type definition by its name (unique).

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the type.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {}

azure.purview.catalog.rest.types.build_delete_type_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete API for type identified by its name.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the type.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

azure.purview.catalog.rest.types.build_get_all_type_definitions_request(*, include_term_template: Optional[bool] = False, type: Union[str, _models.Type, None] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get all type definitions in Atlas in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

include_term_template (bool) – Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template.
type (str or Type) – Typedef name as search filter when get typedefs.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}

azure.purview.catalog.rest.types.build_create_type_definitions_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – A composite wrapper object with corresponding lists of the type definition.
content (Any) – A composite wrapper object with corresponding lists of the type definition.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}


# response body for status code(s): 200
response_body == {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}

azure.purview.catalog.rest.types.build_update_atlas_type_definitions_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – A composite object that captures all type definition changes.
content (Any) – A composite object that captures all type definition changes.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}


# response body for status code(s): 200
response_body == {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}

azure.purview.catalog.rest.types.build_delete_type_definitions_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Delete API for all types in bulk.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

json (Any) – A composite object that captures all types to be deleted.
content (Any) – A composite object that captures all types to be deleted.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "classificationDefs": [
        {
            "entityTypes": [
                "str (optional)"
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "entityDefs": [
        {
            "relationshipAttributeDefs": [
                {
                    "isLegacyAttribute": "bool (optional)",
                    "relationshipTypeName": "str (optional)"
                }
            ],
            "subTypes": [
                "str (optional)"
            ],
            "superTypes": [
                "str (optional)"
            ]
        }
    ],
    "enumDefs": [
        {
            "defaultValue": "str (optional)",
            "elementDefs": [
                {
                    "description": "str (optional)",
                    "ordinal": "float (optional)",
                    "value": "str (optional)"
                }
            ]
        }
    ],
    "relationshipDefs": [
        {
            "endDef1": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "endDef2": {
                "cardinality": "str (optional)",
                "description": "str (optional)",
                "isContainer": "bool (optional)",
                "isLegacyAttribute": "bool (optional)",
                "name": "str (optional)",
                "type": "str (optional)"
            },
            "relationshipCategory": "str (optional)",
            "relationshipLabel": "str (optional)"
        }
    ],
    "structDefs": [
        {
            "attributeDefs": [
                {
                    "cardinality": "str (optional)",
                    "constraints": [
                        {
                            "params": {
                                "str": "object (optional)"
                            },
                            "type": "str (optional)"
                        }
                    ],
                    "defaultValue": "str (optional)",
                    "description": "str (optional)",
                    "includeInNotification": "bool (optional)",
                    "isIndexable": "bool (optional)",
                    "isOptional": "bool (optional)",
                    "isUnique": "bool (optional)",
                    "name": "str (optional)",
                    "options": {
                        "str": "str (optional)"
                    },
                    "typeName": "str (optional)",
                    "valuesMaxCount": "int (optional)",
                    "valuesMinCount": "int (optional)"
                }
            ]
        }
    ],
    "termTemplateDefs": [
        {}
    ]
}

azure.purview.catalog.rest.types.build_list_type_definition_headers_request(*, include_term_template: Optional[bool] = False, type: Union[str, _models.Type, None] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments

include_term_template (bool) – Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template.
type (str or Type) – Typedef name as search filter when get typedefs.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == [
    {
        "category": "str (optional)",
        "guid": "str (optional)",
        "name": "str (optional)"
    }
]

azure.purview.catalog.rest.types.build_get_term_template_def_by_guid_request(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get the term template definition for the given GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: guid (str) – The globally unique identifier of the term template.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {}

azure.purview.catalog.rest.types.build_get_term_template_def_by_name_request(name: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

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

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters: name (str) – The name of the term template.
Returns: Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.
Return type: HttpRequest

Example

# response body for status code(s): 200
response_body == {}