Поделиться через


Web Pub Sub Private Endpoint Connections - List

Вывод списка подключений к частной конечной точке

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections?api-version=2024-03-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

resourceName
path True

string

Имя ресурса.

Шаблон регулярного выражения: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

PrivateEndpointConnectionList

Успешно. В ответе описывается список подключений к частной конечной точке.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

WebPubSubPrivateEndpointConnections_List

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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/privateEndpointConnections?api-version=2024-03-01

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

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

Определения

Имя Описание
createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionList

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

ProvisioningState

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

systemData

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

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

Целевой объект ошибки.

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект error.

PrivateEndpoint

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

Имя Тип Описание
id

string

Полный идентификатор частной конечной точки

PrivateEndpointConnection

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

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Имя ресурса.

properties.groupIds

string[]

Идентификаторы групп

properties.privateEndpoint

PrivateEndpoint

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

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

ProvisioningState

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

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

PrivateEndpointConnectionList

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

Имя Тип Описание
nextLink

string

URL-адрес запроса, который можно использовать для запроса следующей страницы подключений к частной конечной точке. Возвращается, когда общее количество запрошенных подключений к частной конечной точке превышает максимальный размер страницы.

value

PrivateEndpointConnection[]

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

PrivateLinkServiceConnectionState

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

Имя Тип Описание
actionsRequired

string

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

description

string

Причина утверждения или отклонения подключения.

status

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

Имя Тип Описание
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningState

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

Имя Тип Описание
Canceled

string

Creating

string

Deleting

string

Failed

string

Moving

string

Running

string

Succeeded

string

Unknown

string

Updating

string

systemData

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

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

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.