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

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 from the provider of resource the shared private link resource is for.
privateLinkResourceId	string	The resource ID of the resource the shared private link resource is for.
provisioningState	string	The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", "Failed", "Succeeded", and "Incomplete". (Updating, Deleting, Failed, Succeeded, Incomplete)
requestMessage	string	The message for requesting approval of the shared private link resource.
resourceRegion	string	Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status	string	Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". (Pending, Approved, Rejected, Disconnected)
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 from the provider of resource the shared private link resource is for.
privateLinkResourceId	string	The resource ID of the resource the shared private link resource is for.
provisioningState	string	The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", "Failed", "Succeeded", and "Incomplete". (Updating, Deleting, Failed, Succeeded, Incomplete)
requestMessage	string	The message for requesting approval of the shared private link resource.
resourceRegion	string	Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
status	string	Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". (Pending, Approved, Rejected, Disconnected)
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, shared_private_link_resource_name, subscription_id		Gets the details of the shared private link resource managed by 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 shared private link resources managed by the given service.
create_or_update	insert	resource_group_name, search_service_name, shared_private_link_resource_name, subscription_id		Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
create_or_update	replace	resource_group_name, search_service_name, shared_private_link_resource_name, subscription_id		Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
delete	delete	resource_group_name, search_service_name, shared_private_link_resource_name, subscription_id		Initiates the deletion of the shared private link resource from the search service. Returns 202 (Accepted) for asynchronous deletion, 204 (No Content) if the service exists but the shared private link is not found, or 404 (Not Found) if the service is not found. 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
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.
shared_private_link_resource_name	string	The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required.
subscription_id	string

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,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
resourceRegion,
status,
systemData,
type
FROM azure.search.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

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

SELECT
id,
name,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
resourceRegion,
status,
systemData,
type
FROM azure.search.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND search_service_name = '{{ search_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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 (
properties,
resource_group_name,
search_service_name,
shared_private_link_resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ search_service_name }}',
'{{ shared_private_link_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: shared_private_link_resources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: search_service_name
    value: "{{ search_service_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: shared_private_link_resource_name
    value: "{{ shared_private_link_resource_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: properties
    description: |
      Describes the properties of a shared private link resource managed by the Azure AI Search service.
    value:
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      groupId: "{{ groupId }}"
      requestMessage: "{{ requestMessage }}"
      resourceRegion: "{{ resourceRegion }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"

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

REPLACE azure.search.shared_private_link_resources
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND search_service_name = '{{ search_service_name }}' --required
AND shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Initiates the deletion of the shared private link resource from the search service. Returns 202 (Accepted) for asynchronous deletion, 204 (No Content) if the service exists but the shared private link is not found, or 404 (Not Found) if the service is not found. 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.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND search_service_name = '{{ search_service_name }}' --required
AND shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;