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

vw_shared_private_link_resources

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
private_link_resource_id	text	field from the properties object
provisioning_state	text	field from the properties object
request_message	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_region	text	field from the properties object
searchServiceName	text	field from the properties object
sharedPrivateLinkResourceName	text	field from the properties object
status	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"

shared_private_link_resources

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 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

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, searchServiceName, sharedPrivateLinkResourceName, subscriptionId	Gets the details of the shared private link resource managed by the search service in the given resource group.
list_by_service	SELECT	resourceGroupName, searchServiceName, subscriptionId	Gets a list of all shared private link resources managed by the given service.
create_or_update	INSERT	resourceGroupName, searchServiceName, sharedPrivateLinkResourceName, subscriptionId	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	Initiates the deletion of the shared private link resource from the search service.

SELECT examples

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

vw_shared_private_link_resources

SELECT
id,
name,
group_id,
private_link_resource_id,
provisioning_state,
request_message,
resourceGroupName,
resource_region,
searchServiceName,
sharedPrivateLinkResourceName,
status,
subscriptionId,
type
FROM azure.search.vw_shared_private_link_resources
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND searchServiceName = '{{ searchServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

shared_private_link_resources

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

INSERT example

Use the following StackQL query and manifest file to create a new shared_private_link_resources resource.

All Properties

/*+ create */
INSERT INTO azure.search.shared_private_link_resources (
resourceGroupName,
searchServiceName,
sharedPrivateLinkResourceName,
subscriptionId,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ searchServiceName }}',
'{{ sharedPrivateLinkResourceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: privateLinkResourceId
          value: string
        - name: groupId
          value: string
        - name: requestMessage
          value: string
        - name: resourceRegion
          value: string
        - name: status
          value: string
        - name: provisioningState
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified shared_private_link_resources resource.

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