Private Endpoint Connections - Update

Reference

Service:: Search Management

API Version:: 2025-05-01

Updates a private endpoint connection to the search service in the given resource group.

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

URI Parameters

Name	In	Required	Type	Description
privateEndpointConnectionName	path	True	string	The name of the private endpoint connection to the Azure AI Search service with the specified resource group.
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.
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	PrivateEndpointConnectionProperties	Describes the properties of an existing private endpoint connection to the Azure AI Search service.

Responses

Name	Type	Description
200 OK	PrivateEndpointConnection	The existing private endpoint connection definition was successfully updated.
Other Status Codes	CloudError	HTTP 400 (Bad Request): The given private endpoint connection name or the private endpoint connection 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 private endpoint connection 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

PrivateEndpointConnectionUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2025-05-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason."
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason.",
      "actionsRequired": "None"
    }
  }
}

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.
PrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnection	Describes an existing private endpoint connection to the Azure AI Search service.
PrivateEndpointConnectionProperties	Describes the properties of an existing private endpoint connection to the search service.
PrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
PrivateLinkServiceConnectionState	Describes the current state of an existing Azure Private Link service connection to the private endpoint.
PrivateLinkServiceConnectionStatus	Status of the the private link service connection. 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

PrivateEndpoint

Object

The private endpoint resource from Microsoft.Network provider.

Name	Type	Description
id	string	The resource ID of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnection

Object

Describes an existing private endpoint connection to 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	PrivateEndpointConnectionProperties	Describes the properties of an existing private endpoint connection to 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"

PrivateEndpointConnectionProperties

Object

Describes the properties of an existing private endpoint connection to the search service.

Name	Type	Description
groupId	string	The group ID of the Azure resource for which the private link service is for.
privateEndpoint	PrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Describes the current state of an existing Azure Private Link service connection to the private endpoint.
provisioningState	PrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

PrivateLinkServiceConnectionProvisioningState

Enumeration

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

Value	Description
Canceled	Provisioning request for the private link service connection resource has been canceled.
Deleting	The private link service connection is in the process of being deleted.
Failed	The private link service connection has failed to be provisioned or deleted.
Incomplete	Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet.
Succeeded	The private link service connection has finished provisioning and is ready for approval.
Updating	The private link service connection is in the process of being created along with other resources for it to be fully functional.

PrivateLinkServiceConnectionState

Object

Describes the current state of an existing Azure Private Link service connection to the private endpoint.

Name	Type	Default value	Description
actionsRequired	string	None	A description of any extra actions that may be required.
description	string		The description for the private link service connection state.
status	PrivateLinkServiceConnectionStatus		Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

PrivateLinkServiceConnectionStatus

Enumeration

Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

Value	Description
Approved	The private endpoint connection is approved and is ready for use.
Disconnected	The private endpoint connection has been removed from the service.
Pending	The private endpoint connection has been created and is pending approval.
Rejected	The private endpoint connection 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.

Share via

Private Endpoint Connections - Update

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

PrivateEndpointConnectionUpdate

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

createdByType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

systemData