relationship

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

Overview

Name	relationship
Type	Resource
Id	azure.purview_catalog.relationship

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
create	insert	endpoint		Create a new relationship between entities.
update	update	endpoint		Update an existing relationship between entities.
delete	delete	guid, endpoint		Delete a relationship between entities by its GUID.
get_raw	exec	guid, endpoint	extendedInfo	Get relationship information between entities by its GUID.

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 relationship.
extendedInfo	boolean	Limits whether includes extended information. Default value is None.

INSERT examples

create

Create a new relationship between entities.

INSERT INTO azure.purview_catalog.relationship (
endpoint
)
SELECT 
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: relationship
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the relationship resource.

UPDATE examples

update

Update an existing relationship between entities.

UPDATE azure.purview_catalog.relationship
SET 
-- No updatable properties
WHERE 
endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Delete a relationship between entities by its GUID.

DELETE FROM azure.purview_catalog.relationship
WHERE guid = '{{ guid }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Get relationship information between entities by its GUID.

EXEC azure.purview_catalog.relationship.get_raw 
@guid='{{ guid }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@extendedInfo={{ extendedInfo }}
;