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 с указанной группой ресурсов.
resourceGroupName	path	True	string	Имя группы ресурсов в текущей подписке. Это значение можно получить из API Azure Resource Manager или портала.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Это значение можно получить из API Azure Resource Manager или портала.
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

Указывает неявный поток предоставления, как поддерживается на платформе удостоверений Майкрософт.

Тип: oauth2
Flow: 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.
PrivateEndpointConnectionProperties	Описывает свойства существующего подключения частной конечной точки к службе поиска.
PrivateLinkServiceConnectionProvisioningState	Состояние подготовки подключения службы приватного канала. Допустимые значения: "Обновление", "Удаление", "Сбой", "Успешно", "Неполный" или "Отменено".
PrivateLinkServiceConnectionState	Описывает текущее состояние существующего подключения службы Приватного канала Azure к частной конечной точке.
PrivateLinkServiceConnectionStatus	Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

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.

PrivateEndpointConnection

Объект

Описывает существующее подключение частной конечной точки к службе поиска ИИ Azure.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	PrivateEndpointConnectionProperties	Описывает свойства существующего подключения частной конечной точки к службе поиска ИИ Azure.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Объект

Описывает свойства существующего подключения частной конечной точки к службе поиска.

Имя	Тип	Описание
groupId	string	Идентификатор группы ресурса Azure, для которого предназначена служба приватного канала.
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		Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

PrivateLinkServiceConnectionStatus

Перечисление

Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

Значение	Описание
Pending	Подключение к частной конечной точке создано и ожидает утверждения.
Approved	Подключение к частной конечной точке утверждено и готово к использованию.
Rejected	Подключение к частной конечной точке было отклонено и не может использоваться.
Disconnected	Подключение к частной конечной точке было удалено из службы.