private_link_resources

Creates, updates, deletes, gets or lists a private_link_resources resource.

Overview

Name	private_link_resources
Type	Resource
Id	azure.search.private_link_resources

Fields

The following fields are returned by SELECT queries:

list_supported

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 group ID of the private link resource.
requiredMembers	array	The list of required members of the private link resource.
requiredZoneNames	array	The list of required DNS zone names of the private link resource.
shareablePrivateLinkResourceTypes	array	The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
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
list_supported	select	resource_group_name, search_service_name, subscription_id		Gets a list of all supported private link resource types for the given service.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
search_service_name	string	The name of the Azure AI Search service associated with the specified resource group. Required.
subscription_id	string

SELECT examples

list_supported

Gets a list of all supported private link resource types for the given service.

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