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

vw_private_link_hubs

Name	Datatype	Description
location	text	The geo-location where the resource lives
privateLinkHubName	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

private_link_hubs

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	privateLinkHubName, resourceGroupName, subscriptionId	Gets a privateLinkHub
list	SELECT	subscriptionId	Returns a list of privateLinkHubs in a subscription
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns a list of privateLinkHubs in a resource group
create_or_update	INSERT	privateLinkHubName, resourceGroupName, subscriptionId	Creates or updates a privateLinkHub
delete	DELETE	privateLinkHubName, resourceGroupName, subscriptionId	Deletes a privateLinkHub
update	UPDATE	privateLinkHubName, resourceGroupName, subscriptionId	Updates a privateLinkHub

SELECT examples

Returns a list of privateLinkHubs in a subscription

vw_private_link_hubs

SELECT
location,
privateLinkHubName,
private_endpoint_connections,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.synapse.vw_private_link_hubs
WHERE subscriptionId = '{{ subscriptionId }}';

private_link_hubs

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

INSERT example

Use the following StackQL query and manifest file to create a new private_link_hubs resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.private_link_hubs (
privateLinkHubName,
resourceGroupName,
subscriptionId,
tags,
location,
properties
)
SELECT 
'{{ privateLinkHubName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: string

UPDATE example

Updates a private_link_hubs resource.

/*+ update */
UPDATE azure.synapse.private_link_hubs
SET 
tags = '{{ tags }}'
WHERE 
privateLinkHubName = '{{ privateLinkHubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified private_link_hubs resource.

/*+ delete */
DELETE FROM azure.synapse.private_link_hubs
WHERE privateLinkHubName = '{{ privateLinkHubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';