SignalR Private Endpoint Connections - List

Ссылка

Service:: SignalR Service

API Version:: 2021-09-01-preview

Перечисление подключений к частной конечной точке

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections?api-version=2021-09-01-preview

Параметры URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
resourceName	path	True	string	Имя ресурса.
subscriptionId	path	True	string	Возвращает идентификатор подписки, однозначно определяющий Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Name	Type	Description
200 OK	PrivateEndpointConnectionList	Успешно. В ответе описывается список подключений к частной конечной точке.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

SignalRPrivateEndpointConnections_List

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/signalR/mySignalRService/privateEndpointConnections?api-version=2021-09-01-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2015-02-03T04:05:06Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2015-02-03T04:05:06Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "actionsRequired": "None"
        }
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
      "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
      "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
    }
  ]
}

Определения

createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
PrivateEndpoint	Частная конечная точка
PrivateEndpointConnection	Подключение частной конечной точки к ресурсу Azure
PrivateEndpointConnectionList	Список подключений к частной конечной точке
PrivateLinkServiceConnectionState	Состояние подключения частной конечной точки
PrivateLinkServiceConnectionStatus	Указывает, утверждено ли соединение, отклонено или удалено владельцем службы.
ProvisioningState	Состояние подготовки ресурса.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name	Type	Description
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Name	Type	Description
error	ErrorDetail	Объект ошибки.

PrivateEndpoint

Частная конечная точка

Name	Type	Description
id	string	Полный идентификатор частной конечной точки

PrivateEndpointConnection

Подключение частной конечной точки к ресурсу Azure

Name	Type	Description
id	string	Полный идентификатор ресурса для ресурса.
name	string	Имя ресурса.
properties.privateEndpoint	PrivateEndpoint	Частная конечная точка, связанная с подключением к частной конечной точке
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	メンバー ID:
properties.provisioningState	ProvisioningState	Состояние подготовки подключения к частной конечной точке
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса, например "Microsoft.SignalRService/SignalR"

PrivateEndpointConnectionList

Список подключений к частной конечной точке

Name	Type	Description
nextLink	string	URL-адрес запроса, который можно использовать для запроса следующей страницы подключений к частной конечной точке. Возвращается, когда общее число запрошенных подключений к частной конечной точке превышает максимальный размер страницы.
value	PrivateEndpointConnection[]	Список подключений к частной конечной точке

PrivateLinkServiceConnectionState

Состояние подключения частной конечной точки

Name	Type	Description
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения соединения.
status	PrivateLinkServiceConnectionStatus	Указывает, утверждено ли соединение, отклонено или удалено владельцем службы.

PrivateLinkServiceConnectionStatus

Указывает, утверждено ли соединение, отклонено или удалено владельцем службы.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Состояние подготовки ресурса.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Name	Type	Description
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменило ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.