workspace_private_link_resources
Creates, updates, deletes, gets or lists a workspace_private_link_resources resource.
Overview​
| Name | workspace_private_link_resources |
| Type | Resource |
| Id | azure_extras.health_data_services.workspace_private_link_resources |
Fields​
The following fields are returned by SELECT queries:
- get
- list_by_workspace
| 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 | The private link resource private link DNS zone name. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
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 | The private link resource private link DNS zone name. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
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, workspace_name, group_name, subscription_id | Gets a private link resource that need to be created for a workspace. | |
list_by_workspace | select | resource_group_name, workspace_name, subscription_id | Gets the private link resources that need to be created for a workspace. |
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 |
|---|---|---|
group_name | string | The name of the private link resource group. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string | |
workspace_name | string | The name of workspace resource. Required. |
SELECT examples​
- get
- list_by_workspace
Gets a private link resource that need to be created for a workspace.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure_extras.health_data_services.workspace_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND group_name = '{{ group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Gets the private link resources that need to be created for a workspace.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure_extras.health_data_services.workspace_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;