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

vw_private_endpoint_connections

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
group_id	text	field from the properties object
privateEndpointConnectionName	text	field from the properties object
private_endpoint	text	field from the properties object
private_link_service_connection_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
searchServiceName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

private_endpoint_connections

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 search service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	privateEndpointConnectionName, resourceGroupName, searchServiceName, subscriptionId	Gets the details of the private endpoint connection to the search service in the given resource group.
list_by_service	SELECT	resourceGroupName, searchServiceName, subscriptionId	Gets a list of all private endpoint connections in the given service.
delete	DELETE	privateEndpointConnectionName, resourceGroupName, searchServiceName, subscriptionId	Disconnects the private endpoint connection and deletes it from the search service.
update	REPLACE	privateEndpointConnectionName, resourceGroupName, searchServiceName, subscriptionId	Updates a private endpoint connection to the search service in the given resource group.

SELECT examples

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

vw_private_endpoint_connections

SELECT
id,
name,
group_id,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
searchServiceName,
subscriptionId,
type
FROM azure.search.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

private_endpoint_connections

SELECT
id,
name,
properties,
type
FROM azure.search.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

REPLACE example

Replaces all fields in the specified private_endpoint_connections resource.

/*+ update */
REPLACE azure.search.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.search.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';