Shared Private Link Resources - Get

Служба:: Search Management

Версия API:: 2024-03-01-preview

Возвращает сведения о общем ресурсе приватного канала, управляемом службой поиска в данной группе ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2024-03-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
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, связанной с указанной группой ресурсов.
sharedPrivateLinkResourceName	path	True	string	Имя ресурса общего приватного канала, управляемого службой поиска ИИ 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	SharedPrivateLinkResource	Определение ресурса общей приватной связи успешно получено и находится в ответе.
Other Status Codes	CloudError	HTTP 404 (не найдено): не удалось найти подписку, группу ресурсов, службу поиска или общий ресурс приватного канала.

Безопасность

azure_auth

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

SharedPrivateLinkResourceGet

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2024-03-01-preview

Пример ответа

Код состояния:: 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
  }
}

Определения

Имя	Описание
CloudError	Содержит сведения об ошибке API.
CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
SharedPrivateLinkResource	Описывает общий ресурс приватного канала, управляемый службой поиска ИИ Azure.
SharedPrivateLinkResourceProperties	Описывает свойства существующего ресурса общего приватного канала, управляемого службой поиска ИИ Azure.
SharedPrivateLinkResourceProvisioningState	Состояние подготовки общего ресурса приватного канала. Допустимые значения: обновление, удаление, сбой, успешное или неполное.
SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

CloudError

Объект

Содержит сведения об ошибке API.

Имя	Тип	Описание
error	CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
message	string	Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

Описывает определенную ошибку API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details	CloudErrorBody[]	Содержит вложенные ошибки, связанные с этой ошибкой.
message	string	Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

SharedPrivateLinkResource

Объект

Описывает общий ресурс приватного канала, управляемый службой поиска ИИ Azure.

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

SharedPrivateLinkResourceProperties

Объект

Описывает свойства существующего ресурса общего приватного канала, управляемого службой поиска ИИ Azure.

Имя	Тип	Описание
groupId	string	Идентификатор группы от поставщика ресурса, для которой используется общий ресурс приватного канала.
privateLinkResourceId	string	Идентификатор ресурса, для которой используется общий ресурс приватного канала.
provisioningState	SharedPrivateLinkResourceProvisioningState	Состояние подготовки общего ресурса приватного канала. Допустимые значения: обновление, удаление, сбой, успешное или неполное.
requestMessage	string	Сообщение о запросе утверждения общего ресурса приватного канала.
resourceRegion	string	Необязательно. Можно использовать для указания расположения Azure Resource Manager ресурса, для которого создается общая приватная ссылка. Это необходимо только для тех ресурсов, конфигурации DNS которых являются региональными (например, служба Azure Kubernetes).
status	SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

SharedPrivateLinkResourceProvisioningState

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

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

Значение	Описание
Updating	Общий ресурс приватного канала находится в процессе создания вместе с другими ресурсами, чтобы он был полностью функциональным.
Deleting	Общий ресурс приватного канала находится в процессе удаления.
Failed	Не удалось подготовить или удалить общий ресурс приватного канала.
Succeeded	Общий ресурс приватного канала завершил подготовку и готов к утверждению.
Incomplete	Запрос на подготовку ресурса общего приватного канала был принят, но процесс создания еще не начался.

SharedPrivateLinkResourceStatus

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

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

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