Private Endpoint Connections - Get

Gets the details of the private endpoint connection to the search service in the given resource group.

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

URI Parameters

Name In Required Type Description
privateEndpointConnectionName
path True

string

The name of the private endpoint connection to the 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

The name of the 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, command line tools, 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.

Responses

Name Type Description
200 OK

PrivateEndpointConnection

The definition of the private endpoint connection was successfully retrieved and is in the response.

Other Status Codes

CloudError

HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.

Security

azure_auth

Microsoft Entra ID OAuth2 authorization flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

PrivateEndpointConnectionGet

Sample request

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

Sample response

{
  "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": "Approved",
      "description": "",
      "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.

PrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnection

Describes an existing private endpoint connection to the 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, or Incomplete

PrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

PrivateLinkServiceConnectionStatus

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

CloudError

Contains information about an API error.

Name Type Description
error

CloudErrorBody

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

CloudErrorBody

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

PrivateEndpoint

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

Describes an existing private endpoint connection to the search service.

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

PrivateEndpointConnectionProperties

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

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Describes the properties of an existing Private Endpoint connection to the search service.

Name Type Description
groupId

string

The group id from the provider of resource the private link service connection is for.

privateEndpoint

PrivateEndpoint

The private endpoint resource from Microsoft.Network provider.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

provisioningState

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionProvisioningState

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

Name Type Description
Canceled

string

Provisioning request for the private link service connection resource has been canceled

Deleting

string

The private link service connection is in the process of being deleted.

Failed

string

The private link service connection has failed to be provisioned or deleted.

Incomplete

string

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

Succeeded

string

The private link service connection has finished provisioning and is ready for approval.

Updating

string

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

PrivateLinkServiceConnectionState

Describes the current state of an existing Private Link Service connection to the Azure 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

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

Name Type Description
Approved

string

The private endpoint connection is approved and is ready for use.

Disconnected

string

The private endpoint connection has been removed from the service.

Pending

string

The private endpoint connection has been created and is pending approval.

Rejected

string

The private endpoint connection has been rejected and cannot be used.