private_link_resources
Creates, updates, deletes, gets or lists a private_link_resources resource.
Overview
| Name | private_link_resources |
| Type | Resource |
| Id | azure_extras.agrifood.private_link_resources |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_resource
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. E.g. "/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. E.g. "/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, farm_beats_resource_name, sub_resource_name, subscription_id | Get Private link resource object. | |
list_by_resource | select | resource_group_name, farm_beats_resource_name, subscription_id | Get list of Private link resources. |
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 |
|---|---|---|
farm_beats_resource_name | string | FarmBeats resource name. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
sub_resource_name | string | Sub resource name. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_resource
Get Private link resource object.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure_extras.agrifood.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND sub_resource_name = '{{ sub_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Get list of Private link resources.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure_extras.agrifood.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;