private_link_hubs

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

Overview

Name	private_link_hubs
Type	Resource
Id	azure.synapse.private_link_hubs

Fields

The following fields are returned by SELECT queries:

get

PrivateLinkHub resource details

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	PrivateLinkHub resource properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	PrivateLinkHub resource properties
tags	object	Resource tags.

list

PrivateLinkHub resource details

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	PrivateLinkHub resource properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a privateLinkHub
list_by_resource_group	select			Returns a list of privateLinkHubs in a resource group
list	select	subscriptionId		Returns a list of privateLinkHubs in a subscription
create_or_update	insert			Creates or updates a privateLinkHub
update	update			Updates a privateLinkHub
delete	delete			Deletes a privateLinkHub

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
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a privateLinkHub

SELECT
location,
properties,
tags
FROM azure.synapse.private_link_hubs
;

list_by_resource_group

Returns a list of privateLinkHubs in a resource group

SELECT
location,
properties,
tags
FROM azure.synapse.private_link_hubs
;

list

Returns a list of privateLinkHubs in a subscription

SELECT
location,
properties,
tags
FROM azure.synapse.private_link_hubs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a privateLinkHub

INSERT INTO azure.synapse.private_link_hubs (
data__tags,
data__location,
data__properties
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: private_link_hubs
  props:
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        PrivateLinkHub resource properties

UPDATE examples

update

Updates a privateLinkHub

UPDATE azure.synapse.private_link_hubs
SET 
data__tags = '{{ tags }}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a privateLinkHub

DELETE FROM azure.synapse.private_link_hubs
;