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_data_replication.private_link_resources

Fields

The following fields are returned by SELECT queries:

get

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	Gets or sets the group id.
provisioningState	string	Gets or sets the provisioning state of the private link resource. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
requiredMembers	array	Gets or sets the required member. This translates to how many Private IPs should be created for each privately linkable resource.
requiredZoneNames	array	Gets or sets the private DNS zone names.
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".

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	Gets or sets the group id.
provisioningState	string	Gets or sets the provisioning state of the private link resource. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
requiredMembers	array	Gets or sets the required member. This translates to how many Private IPs should be created for each privately linkable resource.
requiredZoneNames	array	Gets or sets the private DNS zone names.
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		Gets the details of site recovery private link resource.
list	select	resource_group_name, vault_name, subscription_id		Gets the 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
private_link_resource_name	string	The private link name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.

SELECT examples

get

Gets the details of site recovery private link resource.

SELECT
id,
name,
groupId,
provisioningState,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.recovery_services_data_replication.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
;

list

Gets the list of private link resources.

SELECT
id,
name,
groupId,
provisioningState,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.recovery_services_data_replication.private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;