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

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 Azure resource for which the private link service is for.
privateEndpoint	object	The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState	object	Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState	string	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. Known values are: "Updating", "Deleting", "Failed", "Succeeded", "Incomplete", and "Canceled". (Updating, Deleting, Failed, Succeeded, Incomplete, Canceled)
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_by_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.
groupId	string	The group ID of the Azure resource for which the private link service is for.
privateEndpoint	object	The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState	object	Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState	string	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. Known values are: "Updating", "Deleting", "Failed", "Succeeded", "Incomplete", and "Canceled". (Updating, Deleting, Failed, Succeeded, Incomplete, Canceled)
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, search_service_name, private_endpoint_connection_name, subscription_id		Gets the details of the private endpoint connection to the search service in the given resource group.
list_by_service	select	resource_group_name, search_service_name, subscription_id		Gets a list of all private endpoint connections in the given service.
update	update	resource_group_name, search_service_name, private_endpoint_connection_name, subscription_id		Updates a private endpoint connection to the search service in the given resource group.
delete	delete	resource_group_name, search_service_name, private_endpoint_connection_name, subscription_id		Disconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with the deleted connection details on successful deletion, or 404 (Not Found) if the connection does not exist. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.

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_endpoint_connection_name	string	The name of the private endpoint connection to the Azure AI Search service with the specified resource group. Required.
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

get

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

SELECT
id,
name,
groupId,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.search.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

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

SELECT
id,
name,
groupId,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.search.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

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

UPDATE azure.search.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND search_service_name = '{{ search_service_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Disconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with the deleted connection details on successful deletion, or 404 (Not Found) if the connection does not exist. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.

DELETE FROM azure.search.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND search_service_name = '{{ search_service_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;