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

@azure/arm-webpubsub package

Классы

WebPubSubManagementClient

Интерфейсы

CustomCertificate

Пользовательский сертификат.
CustomCertificateList

Список настраиваемых сертификатов.
CustomDomain

Личный домен
CustomDomainList

Список пользовательских доменов
Dimension

Спецификации измерения метрик.
ErrorAdditionalInfo

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

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

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
EventHandler

Свойства обработчика событий.
EventHubEndpoint

Конечная точка Концентратора событий. Управляемое удостоверение службы Web PubSub должно быть включено, а удостоверение должно иметь роль "Отправитель данных Центров событий Azure" для доступа к Концентратору событий.
EventListener

Параметр определяет, какие типы событий следует отправлять в какую конечную точку.
EventListenerEndpoint

Конечная точка, указывающая, где web PubSub должен отправлять события.
EventListenerFilter

Базовый класс для фильтра событий, который определяет, следует ли отправлять событие прослушивателю событий.
EventNameFilter

Фильтрация событий по имени.
IPRule

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

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

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

Спецификации журналов для мониторинга Azure.
ManagedIdentity

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

Параметры управляемого удостоверения для вышестоящего потока.
MetricSpecification

Спецификации метрик для мониторинга Azure.
NameAvailability

Результат запроса на проверку доступности имени. Он содержит флаг и возможную причину сбоя.
NameAvailabilityParameters

Data POST-ed в действие nameAvailability
NetworkACL

ACL сети
Operation

Операция REST API, поддерживаемая поставщиком ресурсов.
OperationDisplay

Объект, описывающий операцию.
OperationList

Результат запроса на перечисление операций REST API. Он содержит список операций.
OperationProperties

Свойства дополнительных операций.
Operations

Интерфейс, представляющий операции.
OperationsListNextOptionalParams

Необязательные параметры.
OperationsListOptionalParams

Необязательные параметры.
PrivateEndpoint

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

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

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

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

Ресурс приватного канала
PrivateLinkResourceList

Содержит список PrivateLinkResource и возможную ссылку для запроса дополнительных результатов
PrivateLinkServiceConnectionState

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

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
RegenerateKeyParameters

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

Класс представляет ресурс реплики.
ReplicaList
Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
ResourceLogCategory

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

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

Ссылка на ресурс.
ResourceSku

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

Объект, описывающий спецификацию.
ShareablePrivateLinkResourceProperties

Описание свойств типа ресурса, подключенного к службе приватного канала.
ShareablePrivateLinkResourceType

Описание типа ресурса, подключенного к службе приватного канала.
SharedPrivateLinkResource

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

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

Объект, описывающий конкретное использование ресурсов.
SignalRServiceUsageList

Объект, включающий массив использования ресурсов и возможную ссылку для следующего набора.
SignalRServiceUsageName

Локализуемый объект String, содержащий имя и локализованное значение.
Sku

Описывает доступный номер SKU".
SkuCapacity

Описание сведений о масштабировании номера SKU.
SkuList

Ответ операции skus списка
SystemData

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

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
UpstreamAuthSettings

Параметры вышестоящей проверки подлинности. Если не задано, для исходящих сообщений не используется проверка подлинности.
Usages

Интерфейс, представляющий использование.
UsagesListNextOptionalParams

Необязательные параметры.
UsagesListOptionalParams

Необязательные параметры.
UserAssignedIdentityProperty

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

Интерфейс, представляющий WebPubSub.
WebPubSubCheckNameAvailabilityOptionalParams

Необязательные параметры.
WebPubSubCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubCustomCertificates

Интерфейс, представляющий webPubSubCustomCertificates.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubCustomCertificatesDeleteOptionalParams

Необязательные параметры.
WebPubSubCustomCertificatesGetOptionalParams

Необязательные параметры.
WebPubSubCustomCertificatesListNextOptionalParams

Необязательные параметры.
WebPubSubCustomCertificatesListOptionalParams

Необязательные параметры.
WebPubSubCustomDomains

Интерфейс, представляющий webPubSubCustomDomains.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubCustomDomainsDeleteOptionalParams

Необязательные параметры.
WebPubSubCustomDomainsGetOptionalParams

Необязательные параметры.
WebPubSubCustomDomainsListNextOptionalParams

Необязательные параметры.
WebPubSubCustomDomainsListOptionalParams

Необязательные параметры.
WebPubSubDeleteOptionalParams

Необязательные параметры.
WebPubSubGetOptionalParams

Необязательные параметры.
WebPubSubHub

Параметр концентратора
WebPubSubHubList

Список параметров центра
WebPubSubHubProperties

Свойства концентратора.
WebPubSubHubs

Интерфейс, представляющий WebPubSubHubs.
WebPubSubHubsCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubHubsDeleteOptionalParams

Необязательные параметры.
WebPubSubHubsGetOptionalParams

Необязательные параметры.
WebPubSubHubsListNextOptionalParams

Необязательные параметры.
WebPubSubHubsListOptionalParams

Необязательные параметры.
WebPubSubKeys

Класс представляет ключи доступа ресурса.
WebPubSubListByResourceGroupNextOptionalParams

Необязательные параметры.
WebPubSubListByResourceGroupOptionalParams

Необязательные параметры.
WebPubSubListBySubscriptionNextOptionalParams

Необязательные параметры.
WebPubSubListBySubscriptionOptionalParams

Необязательные параметры.
WebPubSubListKeysOptionalParams

Необязательные параметры.
WebPubSubListReplicaSkusOptionalParams

Необязательные параметры.
WebPubSubListSkusOptionalParams

Необязательные параметры.
WebPubSubManagementClientOptionalParams

Необязательные параметры.
WebPubSubNetworkACLs

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

Интерфейс, представляющий WebPubSubPrivateEndpointConnections.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams

Необязательные параметры.
WebPubSubPrivateEndpointConnectionsGetOptionalParams

Необязательные параметры.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams

Необязательные параметры.
WebPubSubPrivateEndpointConnectionsListOptionalParams

Необязательные параметры.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams

Необязательные параметры.
WebPubSubPrivateLinkResources

Интерфейс, представляющий webPubSubPrivateLinkResources.
WebPubSubPrivateLinkResourcesListNextOptionalParams

Необязательные параметры.
WebPubSubPrivateLinkResourcesListOptionalParams

Необязательные параметры.
WebPubSubRegenerateKeyHeaders

Определяет заголовки для операции WebPubSub_regenerateKey.
WebPubSubRegenerateKeyOptionalParams

Необязательные параметры.
WebPubSubReplicaSharedPrivateLinkResources

Интерфейс, представляющий webPubSubReplicaSharedPrivateLinkResources.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams

Необязательные параметры.
WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams

Необязательные параметры.
WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams

Необязательные параметры.
WebPubSubReplicas

Интерфейс, представляющий webPubSubReplicas.
WebPubSubReplicasCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubReplicasDeleteOptionalParams

Необязательные параметры.
WebPubSubReplicasGetOptionalParams

Необязательные параметры.
WebPubSubReplicasListNextOptionalParams

Необязательные параметры.
WebPubSubReplicasListOptionalParams

Необязательные параметры.
WebPubSubReplicasRestartHeaders

Определяет заголовки для операции WebPubSubReplicas_restart.
WebPubSubReplicasRestartOptionalParams

Необязательные параметры.
WebPubSubReplicasUpdateHeaders

Определяет заголовки для операции WebPubSubReplicas_update.
WebPubSubReplicasUpdateOptionalParams

Необязательные параметры.
WebPubSubResource

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

Объект, содержащий массив ресурсов и возможную ссылку для следующего набора.
WebPubSubRestartHeaders

Определяет заголовки для операции WebPubSub_restart.
WebPubSubRestartOptionalParams

Необязательные параметры.
WebPubSubSharedPrivateLinkResources

Интерфейс, представляющий webPubSubSharedPrivateLinkResources.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Необязательные параметры.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams

Необязательные параметры.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams

Необязательные параметры.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams

Необязательные параметры.
WebPubSubSharedPrivateLinkResourcesListOptionalParams

Необязательные параметры.
WebPubSubSocketIOSettings

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

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

Определяет заголовки для операции WebPubSub_update.
WebPubSubUpdateOptionalParams

Необязательные параметры.

Псевдонимы типа

ACLAction

Определяет значения ACLAction.
KnownACLAction можно использовать взаимозаменяемо с ACLAction, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

разрешить
запретить
CreatedByType

Определяет значения для CreatedByType.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user
приложения
ManagedIdentity
ключ

EventListenerEndpointDiscriminator

Определяет значения для EventListenerEndpointDiscriminator.
KnownEventListenerEndpointDiscriminator можно использовать взаимозаменяемо с EventListenerEndpointDiscriminator, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

EventHub
EventListenerEndpointUnion
EventListenerFilterDiscriminator

Определяет значения для EventListenerFilterDiscriminator.
KnownEventListenerFilterDiscriminator можно использовать взаимозаменяемо с EventListenerFilterDiscriminator, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

EventName
EventListenerFilterUnion
KeyType

Определяет значения для KeyType.
KnownKeyType можно использовать взаимозаменяемо с KeyType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

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

Определяет значения для ManagedIdentityType.
KnownManagedIdentityType можно использовать взаимозаменяемо с ManagedIdentityType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Нет
SystemAssigned
UserAssigned
OperationsListNextResponse

Содержит данные ответа для операции listNext.
OperationsListResponse

Содержит данные ответа для операции списка.
PrivateLinkServiceConnectionStatus

Определяет значения для PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus можно использовать взаимозаменяемо с PrivateLinkServiceConnectionStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ожидающих
утвержденные
отклоненные
отключенные
ProvisioningState

Определяет значения для ProvisioningState.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Неизвестное
успешно выполнено
Сбой
отменено
выполнение
создание
обновление
удаление
перемещение
ScaleType

Определяет значения для ScaleType.
KnownScaleType можно использовать взаимозаменяемо с ScaleType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Нет
вручную
автоматическое

ServiceKind

Определяет значения для ServiceKind.
KnownServiceKind можно использовать взаимозаменяемо с ServiceKind, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

WebPubSub
сокетов

SharedPrivateLinkResourceStatus

Определяет значения для SharedPrivateLinkResourceStatus.
KnownSharedPrivateLinkResourceStatus можно использовать взаимозаменяемо с SharedPrivateLinkResourceStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ожидающих
утвержденные
отклоненные
отключенные
время ожидания
UpstreamAuthType

Определяет значения для UpstreamAuthType.
KnownUpstreamAuthType можно использовать взаимозаменяемо с UpstreamAuthType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Нет
ManagedIdentity
UsagesListNextResponse

Содержит данные ответа для операции listNext.
UsagesListResponse

Содержит данные ответа для операции списка.
WebPubSubCheckNameAvailabilityResponse

Содержит данные ответа для операции checkNameAvailability.
WebPubSubCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubCustomCertificatesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubCustomCertificatesGetResponse

Содержит данные ответа для операции получения.
WebPubSubCustomCertificatesListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubCustomCertificatesListResponse

Содержит данные ответа для операции списка.
WebPubSubCustomDomainsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubCustomDomainsGetResponse

Содержит данные ответа для операции получения.
WebPubSubCustomDomainsListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubCustomDomainsListResponse

Содержит данные ответа для операции списка.
WebPubSubGetResponse

Содержит данные ответа для операции получения.
WebPubSubHubsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubHubsGetResponse

Содержит данные ответа для операции получения.
WebPubSubHubsListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubHubsListResponse

Содержит данные ответа для операции списка.
WebPubSubListByResourceGroupNextResponse

Содержит данные ответа для операции listByResourceGroupNext.
WebPubSubListByResourceGroupResponse

Содержит данные ответа для операции listByResourceGroup.
WebPubSubListBySubscriptionNextResponse

Содержит данные ответа для операции listBySubscriptionNext.
WebPubSubListBySubscriptionResponse

Содержит данные ответа для операции listBySubscription.
WebPubSubListKeysResponse

Содержит данные ответа для операции listKeys.
WebPubSubListReplicaSkusResponse

Содержит данные ответа для операции listReplicaSkus.
WebPubSubListSkusResponse

Содержит данные ответа для операции listSkus.
WebPubSubPrivateEndpointConnectionsGetResponse

Содержит данные ответа для операции получения.
WebPubSubPrivateEndpointConnectionsListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubPrivateEndpointConnectionsListResponse

Содержит данные ответа для операции списка.
WebPubSubPrivateEndpointConnectionsUpdateResponse

Содержит данные ответа для операции обновления.
WebPubSubPrivateLinkResourcesListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubPrivateLinkResourcesListResponse

Содержит данные ответа для операции списка.
WebPubSubRegenerateKeyResponse

Содержит данные ответа для операции повторного создания ключей.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubReplicaSharedPrivateLinkResourcesGetResponse

Содержит данные ответа для операции получения.
WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubReplicaSharedPrivateLinkResourcesListResponse

Содержит данные ответа для операции списка.
WebPubSubReplicasCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubReplicasGetResponse

Содержит данные ответа для операции получения.
WebPubSubReplicasListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubReplicasListResponse

Содержит данные ответа для операции списка.
WebPubSubReplicasRestartResponse

Содержит данные ответа для операции перезапуска.
WebPubSubReplicasUpdateResponse

Содержит данные ответа для операции обновления.
WebPubSubRequestType

Определяет значения для WebPubSubRequestType.
KnownWebPubSubRequestType можно использовать взаимозаменяемо с WebPubSubRequestType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ClientConnection
ServerConnection
RESTAPI
трассировки
WebPubSubRestartResponse

Содержит данные ответа для операции перезапуска.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
WebPubSubSharedPrivateLinkResourcesGetResponse

Содержит данные ответа для операции получения.
WebPubSubSharedPrivateLinkResourcesListNextResponse

Содержит данные ответа для операции listNext.
WebPubSubSharedPrivateLinkResourcesListResponse

Содержит данные ответа для операции списка.
WebPubSubSkuTier

Определяет значения для WebPubSubSkuTier.
KnownWebPubSubSkuTier можно использовать взаимозаменяемо с WebPubSubSkuTier, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

бесплатные
базовый
категории "Стандартный"
Premium
WebPubSubUpdateResponse

Содержит данные ответа для операции обновления.

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

KnownACLAction

Известные значения ACLAction, которые принимает служба.
KnownCreatedByType

Известные значения CreatedByType, которые принимает служба.
KnownEventListenerEndpointDiscriminator

Известные значения EventListenerEndpointDiscriminator, которые служба принимает.
KnownEventListenerFilterDiscriminator

Известные значения EventListenerFilterDiscriminator, которые служба принимает.
KnownKeyType

Известные значения KeyType, которые служба принимает.
KnownManagedIdentityType

Известные значения ManagedIdentityType, которые принимает служба.
KnownPrivateLinkServiceConnectionStatus

Известные значения PrivateLinkServiceConnectionStatus, которые принимает служба.
KnownProvisioningState

Известные значения ProvisioningState, которые принимает служба.
KnownScaleType

Известные значения ScaleType, которые принимает служба.
KnownServiceKind

Известные значения ServiceKind, которые служба принимает.
KnownSharedPrivateLinkResourceStatus

Известные значения SharedPrivateLinkResourceStatus, которые служба принимает.
KnownUpstreamAuthType

Известные значения UpstreamAuthType, которые принимает служба.
KnownWebPubSubRequestType

Известные значения WebPubSubRequestType, которые служба принимает.
KnownWebPubSubSkuTier

Известные значения WebPubSubSkuTier, которые служба принимает.

Функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

Сведения о функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект от доступа к value на итераторе IteratorResult из byPage итератора.

Возвращаемое значение

string | undefined

Маркер продолжения, который можно передать в byPage() во время будущих вызовов.