private_link_resources_supported

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

Overview

Name	private_link_resources_supported
Type	Resource
Id	azure.search.private_link_resources_supported

Fields

The following fields are returned by SELECT queries:

list

The operation succeeded. The response contains the list of all supported private link resource types for the given service.

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
properties	object	Describes the properties of a supported private link resource for the Azure AI Search service.
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	select	subscriptionId, resourceGroupName, searchServiceName	x-ms-client-request-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
resourceGroupName	string	The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName	string	The name of the Azure AI Search service associated with the specified resource group.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.
x-ms-client-request-id	string (uuid)	A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

SELECT examples

list

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

SELECT
id,
name,
properties,
type
FROM azure.search.private_link_resources_supported
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND searchServiceName = '{{ searchServiceName }}' -- required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
;