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

Web Pub Sub - Get

  • Ссылка
Служба:
Azure Web PubSub Service
Версия API:
2024-03-01

Получение ресурса и его свойств.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}?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

WebPubSubResource

Успешно. В ответе описывается соответствующий ресурс.
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

WebPubSub_Get

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

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

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

Код состояния:
200 
{
  "sku": {
    "name": "Premium_P1",
    "tier": "Premium",
    "size": "P1",
    "capacity": 1
  },
  "properties": {
    "provisioningState": "Succeeded",
    "externalIP": "10.0.0.1",
    "hostName": "mywebpubsubservice.webpubsub.azure.com",
    "publicPort": 443,
    "serverPort": 443,
    "version": "1.0",
    "privateEndpointConnections": [
      {
        "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/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"
        }
      }
    ],
    "tls": {
      "clientCertEnabled": true
    },
    "liveTraceConfiguration": {
      "enabled": "false",
      "categories": [
        {
          "name": "ConnectivityLogs",
          "enabled": "true"
        }
      ]
    },
    "resourceLogConfiguration": {
      "categories": [
        {
          "name": "ConnectivityLogs",
          "enabled": "true"
        }
      ]
    },
    "networkACLs": {
      "defaultAction": "Deny",
      "publicNetwork": {
        "allow": [
          "ClientConnection"
        ]
      },
      "privateEndpoints": [
        {
          "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
          "allow": [
            "ServerConnection"
          ]
        }
      ],
      "ipRules": [
        {
          "value": "123.456.789.123/24",
          "action": "Allow"
        },
        {
          "value": "123.456.789.123",
          "action": "Allow"
        },
        {
          "value": "AppService",
          "action": "Allow"
        }
      ]
    },
    "publicNetworkAccess": "Enabled",
    "disableLocalAuth": false,
    "disableAadAuth": false,
    "regionEndpointEnabled": "Enabled",
    "resourceStopped": "false",
    "socketIO": {
      "serviceMode": "Serverless"
    }
  },
  "kind": "WebPubSub",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "tags": {
    "key1": "value1"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService",
  "name": "myWebPubSubService",
  "type": "Microsoft.SignalRService/WebPubSub",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2015-02-03T04:05:06Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2015-02-03T04:05:06Z"
  }
}

Определения

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

Действие ACL сети Azure.
createdByType

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

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

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

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

Правило IP-адресов
LiveTraceCategory

Динамическая конфигурация категории трассировки ресурса Microsoft.SignalRService.
LiveTraceConfiguration

Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.
ManagedIdentity

Класс представляет управляемые удостоверения, используемые для запроса и ответа.
ManagedIdentityType

Представляет тип удостоверения: systemAssigned, userAssigned, None
NetworkACL

Список управления сетевым доступом
PrivateEndpoint

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

ACL для частной конечной точки
PrivateEndpointConnection

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

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

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

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

Конфигурация категории журнала ресурсов для ресурса Microsoft.SignalRService.
ResourceLogConfiguration

Конфигурация журнала ресурсов для ресурса Microsoft.SignalRService.
ResourceSku

Сведения о выставлении счетов для ресурса.
ServiceKind

Тип службы
SharedPrivateLinkResource

Описание общего ресурса Приватный канал
SharedPrivateLinkResourceStatus

Состояние общего ресурса приватного канала
systemData

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

Свойства удостоверения, назначаемого пользователем.
WebPubSubNetworkACLs

Списки управления доступом к сети для ресурса
WebPubSubRequestType

Тип входящего запроса к службе
WebPubSubResource

Класс представляет ресурс.
WebPubSubSkuTier

Необязательный уровень конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic является нерекомендуемой, вместо него используйте Standard .
WebPubSubSocketIOSettings

Параметры SocketIO для ресурса
WebPubSubTlsSettings

Параметры TLS для ресурса

ACLAction

Enumeration

Действие ACL сети Azure.

Значение Описание
Allow
Deny

createdByType

Enumeration

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

Значение Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

Object

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

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

ErrorDetail

Объект error.

IPRule

Object

Правило IP-адресов

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

ACLAction

Действие ACL сети Azure.
value

string

IP-адрес, CIDR или ServiceTag

LiveTraceCategory

Object

Динамическая конфигурация категории трассировки ресурса Microsoft.SignalRService.

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

string

Указывает, включена ли категория динамической трассировки или . Доступные значения: true, false. Без учета регистра.
name

string

Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра.

LiveTraceConfiguration

Object

Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.

Имя Тип Default value Описание
categories

LiveTraceCategory[]

Возвращает или задает список конфигураций категорий.
enabled

string

false

Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не сможет подключиться к службе, поэтому вы не сможете получить журнал, независимо от того, что вы настроите в разделе "категории". Доступные значения: true, false. Без учета регистра.

ManagedIdentity

Object

Класс представляет управляемые удостоверения, используемые для запроса и ответа.

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

string

Получите идентификатор субъекта для назначенного системой удостоверения. Используется только в ответе.
tenantId

string

Получите идентификатор клиента для удостоверения, назначаемого системой. Используется только в ответе
type

ManagedIdentityType

Представляет тип удостоверения: systemAssigned, userAssigned, None
userAssignedIdentities

<string,  UserAssignedIdentityProperty>

Получение или настройка удостоверений, назначаемых пользователем

ManagedIdentityType

Enumeration

Представляет тип удостоверения: systemAssigned, userAssigned, None

Значение Описание
None
SystemAssigned
UserAssigned

NetworkACL

Object

Список управления сетевым доступом

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

WebPubSubRequestType[]

Разрешенные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
deny

WebPubSubRequestType[]

Отклоненные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Object

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

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

string

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

PrivateEndpointACL

Object

ACL для частной конечной точки

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

WebPubSubRequestType[]

Разрешенные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
deny

WebPubSubRequestType[]

Отклоненные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
name

string

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

PrivateEndpointConnection

Object

Подключение частной конечной точки к ресурсу 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.

PrivateLinkServiceConnectionState

Object

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

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

string

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

string

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

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

Enumeration

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

Значение Описание
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

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

Значение Описание
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

Конфигурация категории журнала ресурсов для ресурса Microsoft.SignalRService.

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

string

Указывает, включена ли категория журнала ресурсов или . Доступные значения: true, false. Без учета регистра.
name

string

Возвращает или задает имя категории журнала ресурсов. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра.

ResourceLogConfiguration

Object

Конфигурация журнала ресурсов для ресурса Microsoft.SignalRService.

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

ResourceLogCategory[]

Возвращает или задает список конфигураций категорий.

ResourceSku

Object

Сведения о выставлении счетов для ресурса.

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

integer

Необязательный, целое число. Количество единиц ресурса. 1 для Free_F1/Standard_S1/Premium_P1, 100 для Premium_P2 по умолчанию.

При наличии допустимы следующие значения: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100 200 300 400 500 600 700 800 900 1000;
family

string

Не используется. Сохраняется для использования в будущем.
name

string

Имя номера SKU. Обязательный.

Допустимые значения: Standard_S1, Free_F1, Premium_P1, Premium_P2
size

string

Не используется. Сохраняется для использования в будущем.
tier

WebPubSubSkuTier

Необязательный уровень конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic является нерекомендуемой, вместо него используйте Standard .

ServiceKind

Enumeration

Тип службы

Значение Описание
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

Описание общего ресурса Приватный канал

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

string

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

string

Имя ресурса.
properties.groupId

string

Идентификатор группы поставщика ресурса, для которой используется общий ресурс приватного канала.
properties.privateLinkResourceId

string

Идентификатор ресурса, для который используется общий ресурс приватного канала.
properties.provisioningState

ProvisioningState

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

string

Сообщение запроса на утверждение общего ресурса приватного канала
properties.status

SharedPrivateLinkResourceStatus

Состояние общего ресурса приватного канала
systemData

systemData

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

string

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

SharedPrivateLinkResourceStatus

Enumeration

Состояние общего ресурса приватного канала

Значение Описание
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

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

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

string

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

string

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

createdByType

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

string

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

string

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

createdByType

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

UserAssignedIdentityProperty

Object

Свойства удостоверения, назначаемого пользователем.

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

string

Получение идентификатора клиента для удостоверения, назначаемого пользователем
principalId

string

Получение идентификатора субъекта для удостоверения, назначаемого пользователем

WebPubSubNetworkACLs

Object

Списки управления доступом к сети для ресурса

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

ACLAction

Действие ACL сети Azure.
ipRules

IPRule[]

Правила IP-адресов для фильтрации общедоступного трафика
privateEndpoints

PrivateEndpointACL[]

Списки управления доступом для запросов от частных конечных точек
publicNetwork

NetworkACL

Список управления сетевым доступом

WebPubSubRequestType

Enumeration

Тип входящего запроса к службе

Значение Описание
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

Класс представляет ресурс.

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

string

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

ManagedIdentity

Класс представляет управляемые удостоверения, используемые для запроса и ответа.
kind

ServiceKind

Тип службы
location

string

Географическое расположение, в котором находится ресурс
name

string

Имя ресурса.
properties.disableAadAuth

boolean

False

DisableLocalAuth Включение или отключение проверки подлинности aad. Если задано значение true, подключение с AuthType=aad не будет работать.
properties.disableLocalAuth

boolean

False

DisableLocalAuth. Включение или отключение локальной проверки подлинности с помощью AccessKey. Если задано значение true, подключение с accessKey=xxx не будет работать.
properties.externalIP

string

Общедоступный IP-адрес ресурса.
properties.hostName

string

Полное доменное имя экземпляра службы.
properties.hostNamePrefix

string

Не рекомендуется.
properties.liveTraceConfiguration

LiveTraceConfiguration

Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.
properties.networkACLs

WebPubSubNetworkACLs

Списки управления доступом к сети для ресурса
properties.privateEndpointConnections

PrivateEndpointConnection[]

Подключения частной конечной точки к ресурсу.
properties.provisioningState

ProvisioningState

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

string

Enabled

Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если параметр включен, списки управления доступом к сети по-прежнему применяются. Если параметр отключен, доступ к общедоступной сети всегда отключается независимо от того, что вы задали в списках управления доступом к сети.
properties.publicPort

integer

Общедоступный порт ресурса, предназначенный для использования на стороне браузера или клиента.
properties.regionEndpointEnabled

string

Enabled

Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". Если параметр отключен, новые подключения не будут направляться в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство реплика специфично. Отключить региональную конечную точку без реплика не разрешено.
properties.resourceLogConfiguration

ResourceLogConfiguration

Конфигурация журнала ресурсов для ресурса Microsoft.SignalRService.
properties.resourceStopped

string

false

Остановите или запустите ресурс. Значение по умолчанию — False. Если значение равно true, плоскость данных ресурса завершает работу. Если значение равно false, запускается плоскость данных ресурса.
properties.serverPort

integer

Общедоступный порт ресурса, предназначенный для использования на стороне клиента.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Список общих ресурсов приватного канала.
properties.socketIO

WebPubSubSocketIOSettings

Параметры SocketIO для ресурса
properties.tls

WebPubSubTlsSettings

Параметры TLS для ресурса
properties.version

string

Версия ресурса. Возможно, вам нужна та же или более поздняя версия клиентских пакетов SDK.
sku

ResourceSku

Сведения о выставлении счетов для ресурса.
systemData

systemData

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

object

Теги ресурсов.
type

string

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

WebPubSubSkuTier

Enumeration

Необязательный уровень конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic является нерекомендуемой, вместо него используйте Standard .

Значение Описание
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

Параметры SocketIO для ресурса

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

string

Режим службы Web PubSub для Socket.IO. Допустимые значения: "Default": имеете собственный сервер Socket.IO "Бессерверный": у приложения нет внутреннего сервера

WebPubSubTlsSettings

Object

Параметры TLS для ресурса

Имя Тип Default value Описание
clientCertEnabled

boolean

False

Запросите сертификат клиента во время подтверждения TLS, если он включен. Не поддерживается для уровня "Бесплатный". Все входные данные будут игнорироваться для уровня "Бесплатный".