private_link_resources
Creates, updates, deletes, gets or lists a private_link_resources resource.
Overview
| Name | private_link_resources |
| Type | Resource |
| Id | azure.recovery_services.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 | e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery). |
requiredMembers | array | [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1]. |
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 | e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery). |
requiredMembers | array | [backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1]. |
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, vault_name, private_link_resource_name, subscription_id | Returns a specified private link resource that need to be created for Backup and SiteRecovery. | |
list | select | resource_group_name, vault_name, subscription_id | Returns the list of private link resources that need to be created for Backup and SiteRecovery. |
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_resource_name | string | Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string | |
vault_name | string | The name of the recovery services vault. Required. |
SELECT examples
- get
- list
Returns a specified private link resource that need to be created for Backup and SiteRecovery.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.recovery_services.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND private_link_resource_name = '{{ private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Returns the list of private link resources that need to be created for Backup and SiteRecovery.
SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.recovery_services.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;