Share via

Shared Private Link Resources - Create Or Update

  • Reference
Service:
Search Management
API Version:
2025-05-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2025-05-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

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

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

The name of the Azure AI Search service associated with the specified resource group.
sharedPrivateLinkResourceName
 path True

string

The name of the shared private link resource managed by the Azure AI Search service within the specified resource group.
subscriptionId
 path True

string

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.
api-version
 query True

string

The API version to use for each request.

Request Header

Name Required Type Description
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.

Request Body

Name Type Description
properties

SharedPrivateLinkResourceProperties

Describes the properties of a shared private link resource managed by the Azure AI Search service.

Responses

Name Type Description
200 OK

SharedPrivateLinkResource

The details of the shared private link resource that was created or updated.
202 Accepted

The shared private link resource create or update operation has been accepted and will complete asynchronously.
Other Status Codes

CloudError

HTTP 400 (Bad Request): The given shared private link resource name or the shared private link resource definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found. HTTP 409 (Conflict): The specified subscription is disabled.

Security

azure_auth

Specifies an implicit grant flow, as supported on the Microsoft Identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

SharedPrivateLinkResourceCreateOrUpdate

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-05-01

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

Sample response

Status code:
202 
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Status code:
200 
{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

Definitions

Name Description
CloudError

Contains information about an API error.
CloudErrorBody

Describes a particular API error with an error code and a message.
createdByType

The type of identity that created the resource.
SharedPrivateLinkResource

Describes a shared private link resource managed by the Azure AI Search service.
SharedPrivateLinkResourceProperties

Describes the properties of an existing shared private link resource managed by the Azure AI Search service.
SharedPrivateLinkResourceProvisioningState

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
SharedPrivateLinkResourceStatus

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
systemData

Metadata pertaining to creation and last modification of the resource.

CloudError

Object

Contains information about an API error.

Name Type Description
error

CloudErrorBody

Describes a particular API error with an error code and a message.
message

string

A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property).

CloudErrorBody

Object

Describes a particular API error with an error code and a message.

Name Type Description
code

string

An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
details

CloudErrorBody[]

Contains nested errors that are related to this error.
message

string

A message that describes the error in detail and provides debugging information.
target

string

The target of the particular error (for example, the name of the property in error).

createdByType

Enumeration

The type of identity that created the resource.

Value Description
Application
Key
ManagedIdentity
User

SharedPrivateLinkResource

Object

Describes a shared private link resource managed by the Azure AI Search service.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

The name of the resource
properties

SharedPrivateLinkResourceProperties

Describes the properties of a shared private link resource managed by the Azure AI Search service.
systemData

systemData

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"

SharedPrivateLinkResourceProperties

Object

Describes the properties of an existing shared private link resource managed by the Azure AI Search service.

Name Type Description
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

SharedPrivateLinkResourceProvisioningState

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or 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

SharedPrivateLinkResourceStatus

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

SharedPrivateLinkResourceProvisioningState

Enumeration

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

Value Description
Deleting

The shared private link resource is in the process of being deleted.
Failed

The shared private link resource has failed to be provisioned or deleted.
Incomplete

Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
Succeeded

The shared private link resource has finished provisioning and is ready for approval.
Updating

The shared private link resource is in the process of being created along with other resources for it to be fully functional.

SharedPrivateLinkResourceStatus

Enumeration

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

Value Description
Approved

The shared private link resource is approved and is ready for use.
Disconnected

The shared private link resource has been removed from the service.
Pending

The shared private link resource has been created and is pending approval.
Rejected

The shared private link resource has been rejected and cannot be used.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.