shared_private_link_resources

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

Overview

Name	shared_private_link_resources
Type	Resource
Id	azure.search.shared_private_link_resources

Fields

The following fields are returned by SELECT queries:

get

The definition of the shared private link resource 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 a shared private link resource managed by 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 shared private link resources managed by 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 shared private link resource managed by 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, sharedPrivateLinkResourceName, subscriptionId	x-ms-client-request-id	Gets the details of the shared private link resource managed by 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 shared private link resources managed by the given service.
create_or_update	insert	resourceGroupName, searchServiceName, sharedPrivateLinkResourceName, subscriptionId	x-ms-client-request-id	Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
delete	delete	resourceGroupName, searchServiceName, sharedPrivateLinkResourceName, subscriptionId	x-ms-client-request-id	Initiates the deletion of the shared private link resource 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
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.
sharedPrivateLinkResourceName	string	The name of the shared private link resource managed by the Azure AI Search service within 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 shared private link resource managed by the search service in the given resource group.

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

list_by_service

Gets a list of all shared private link resources managed by the given service.

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

INSERT examples

create_or_update

Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.

INSERT INTO azure.search.shared_private_link_resources (
data__properties,
resourceGroupName,
searchServiceName,
sharedPrivateLinkResourceName,
subscriptionId,
x-ms-client-request-id
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ searchServiceName }}',
'{{ sharedPrivateLinkResourceName }}',
'{{ subscriptionId }}',
'{{ x-ms-client-request-id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: shared_private_link_resources
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the shared_private_link_resources resource.
    - name: searchServiceName
      value: string
      description: Required parameter for the shared_private_link_resources resource.
    - name: sharedPrivateLinkResourceName
      value: string
      description: Required parameter for the shared_private_link_resources resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the shared_private_link_resources resource.
    - name: properties
      value: object
      description: |
        Describes the properties of a shared private link resource managed by the Azure AI Search service.
    - name: x-ms-client-request-id
      value: string (uuid)
      description: 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.

DELETE examples

delete

Initiates the deletion of the shared private link resource from the search service.

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