你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Private Endpoint Connections - Get

服务:: Search Management

API 版本:: 2025-02-01-preview

获取与给定资源组中搜索服务的专用终结点连接的详细信息。

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

URI 参数

名称	在	必需	类型	说明
privateEndpointConnectionName	path	True	string	与具有指定资源组的 Azure AI 搜索服务的专用终结点连接的名称。
resourceGroupName	path	True	string	当前订阅中的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	与指定资源组关联的 Azure AI 搜索服务的名称。
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。可以从 Azure 资源管理器 API 或门户获取此值。
api-version	query	True	string	要用于每个请求的 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	一个客户端生成的 GUID 值，用于标识此请求。如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	已成功检索专用终结点连接的定义，并且位于响应中。
Other Status Codes	CloudError	HTTP 404（找不到）：找不到订阅、资源组、搜索服务或专用终结点连接。

安全性

azure_auth

指定Microsoft标识平台上支持的隐式授权流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

PrivateEndpointConnectionGet

示例请求

HTTP

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

示例响应

状态代码:: 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": "Approved",
      "description": "",
      "actionsRequired": "None"
    }
  }
}

定义

名称	说明
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
PrivateEndpoint	来自 Microsoft.Network 提供程序的专用终结点资源。
PrivateEndpointConnection	描述与 Azure AI 搜索服务的现有专用终结点连接。
PrivateEndpointConnectionProperties	描述与搜索服务的现有专用终结点连接的属性。
PrivateLinkServiceConnectionProvisioningState	专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。
PrivateLinkServiceConnectionState	描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。
PrivateLinkServiceConnectionStatus	专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

CloudError

对象

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
message	string	提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

对象

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

PrivateEndpoint

对象

来自 Microsoft.Network 提供程序的专用终结点资源。

名称	类型	说明
id	string	来自 Microsoft.Network 提供程序的专用终结点资源的资源 ID。

PrivateEndpointConnection

对象

描述与 Azure AI 搜索服务的现有专用终结点连接。

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties	PrivateEndpointConnectionProperties	介绍与 Azure AI 搜索服务的现有专用终结点连接的属性。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

对象

描述与搜索服务的现有专用终结点连接的属性。

名称	类型	说明
groupId	string	专用链接服务的 Azure 资源的组 ID。
privateEndpoint	PrivateEndpoint	来自 Microsoft.Network 提供程序的专用终结点资源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。
provisioningState	PrivateLinkServiceConnectionProvisioningState	专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。

PrivateLinkServiceConnectionProvisioningState

枚举

专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。

值	说明
Updating	专用链接服务连接正在与其他资源一起创建，以便其功能完全正常运行。
Deleting	正在删除专用链接服务连接。
Failed	无法预配或删除专用链接服务连接。
Succeeded	专用链接服务连接已完成预配，可供审批。
Incomplete	已接受专用链接服务连接资源的预配请求，但尚未开始创建过程。
Canceled	已取消专用链接服务连接资源的预配请求。

PrivateLinkServiceConnectionState

对象

描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。

名称	类型	默认值	说明
actionsRequired	string	None	对可能需要执行的任何额外操作的说明。
description	string		专用链接服务连接状态的说明。
status	PrivateLinkServiceConnectionStatus		专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

PrivateLinkServiceConnectionStatus

枚举

专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

值	说明
Pending	已创建专用终结点连接，并且正在等待审批。
Approved	专用终结点连接已获批准，可供使用。
Rejected	专用终结点连接已被拒绝，不能使用。
Disconnected	专用终结点连接已从服务中删除。