private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.search.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The definition of the private endpoint connection was successfully retrieved and is in the response.

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 an existing private endpoint connection to the Azure AI Search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_service

The operation succeeded. The response contains the list of all private endpoint connections 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 an existing private endpoint connection to 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
get	select	resourceGroupName, searchServiceName, privateEndpointConnectionName, subscriptionId	x-ms-client-request-id	Gets the details of the private endpoint connection to the search service in the given resource group.
list_by_service	select	subscriptionId, resourceGroupName, searchServiceName	x-ms-client-request-id	Gets a list of all private endpoint connections in the given service.
update	replace	resourceGroupName, searchServiceName, privateEndpointConnectionName, subscriptionId	x-ms-client-request-id	Updates a private endpoint connection to the search service in the given resource group.
delete	delete	resourceGroupName, searchServiceName, privateEndpointConnectionName, subscriptionId	x-ms-client-request-id	Disconnects the private endpoint connection and deletes it from the search 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
privateEndpointConnectionName	string	The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
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

get

Gets the details of the private endpoint connection to the search service in the given resource group.

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

list_by_service

Gets a list of all private endpoint connections in the given service.

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

REPLACE examples

update

Updates a private endpoint connection to the search service in the given resource group.

REPLACE azure.search.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND searchServiceName = '{{ searchServiceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND x-ms-client-request-id = '{{ x-ms-client-request-id}}'
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Disconnects the private endpoint connection and deletes it from the search service.

DELETE FROM azure.search.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND searchServiceName = '{{ searchServiceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
;