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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	PrivateLinkHub provisioning state.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	PrivateLinkHub provisioning state.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	PrivateLinkHub provisioning state.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_link_hub_name, subscription_id		Gets a privateLinkHub.
list_by_resource_group	select	resource_group_name, subscription_id		Returns a list of privateLinkHubs in a resource group.
list	select	subscription_id		Returns a list of privateLinkHubs in a subscription.
create_or_update	insert	resource_group_name, private_link_hub_name, subscription_id, location		Creates or updates a privateLinkHub.
update	update	resource_group_name, private_link_hub_name, subscription_id		Updates a privateLinkHub.
create_or_update	replace	resource_group_name, private_link_hub_name, subscription_id, location		Creates or updates a privateLinkHub.
delete	delete	resource_group_name, private_link_hub_name, subscription_id		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
private_link_hub_name	string	Name of the privateLinkHub. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a privateLinkHub.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
tags,
type
FROM azure.synapse.private_link_hubs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_hub_name = '{{ private_link_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns a list of privateLinkHubs in a resource group.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
tags,
type
FROM azure.synapse.private_link_hubs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of privateLinkHubs in a subscription.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
tags,
type
FROM azure.synapse.private_link_hubs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a privateLinkHub.

INSERT INTO azure.synapse.private_link_hubs (
tags,
location,
properties,
resource_group_name,
private_link_hub_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ private_link_hub_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_hubs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_link_hubs resource.
  - name: private_link_hub_name
    value: "{{ private_link_hub_name }}"
    description: Required parameter for the private_link_hubs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_link_hubs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a privateLinkHub.

UPDATE azure.synapse.private_link_hubs
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_link_hub_name = '{{ private_link_hub_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a privateLinkHub.

REPLACE azure.synapse.private_link_hubs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_link_hub_name = '{{ private_link_hub_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a privateLinkHub.

DELETE FROM azure.synapse.private_link_hubs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_link_hub_name = '{{ private_link_hub_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;