private_link_hub_private_link_resources
Creates, updates, deletes, gets or lists a private_link_hub_private_link_resources resource.
Overview
| Name | private_link_hub_private_link_resources |
| Type | Resource |
| Id | azure.synapse.private_link_hub_private_link_resources |
Fields
The following fields are returned by SELECT queries:
- get
- 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. |
groupId | string | The private link resource group id. |
requiredMembers | array | The private link resource required member names. |
requiredZoneNames | array | Required DNS zone names of the the private link resource. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| 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. |
groupId | string | The private link resource group id. |
requiredMembers | array | The private link resource required member names. |
requiredZoneNames | array | Required DNS zone names of the the private link resource. |
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, private_link_resource_name, subscription_id | Get Private Link Hub Private Link Resource. Get private link resource in private link hub. | |
list | select | resource_group_name, private_link_hub_name, subscription_id | Private Link Resources. Get all private link resources for a private link hub. |
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 | The name of the private link hub. Required. |
private_link_resource_name | string | The name of the private link resource. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list
Get Private Link Hub Private Link Resource. Get private link resource in private link hub.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.synapse.private_link_hub_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_hub_name = '{{ private_link_hub_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Private Link Resources. Get all private link resources for a private link hub.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
type
FROM azure.synapse.private_link_hub_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_hub_name = '{{ private_link_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;