使用英语阅读

通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-webpubsub package

接口

CustomCertificate

自定义证书。

CustomCertificateList

自定义证书列表。

CustomDomain

自定义域

CustomDomainList

自定义域列表

Dimension

指标维度的规范。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。 (这也遵循 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 to the nameAvailability action

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 资源管理器代理资源的资源模型定义。 它不具有标记和位置

RegenerateKeyParameters

参数描述重新生成访问密钥的请求

Replica

一个类表示副本资源。

ReplicaList
Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

ResourceLogCategory

Microsoft.SignalRService 资源的资源日志类别配置。

ResourceLogConfiguration

Microsoft.SignalRService 资源的资源日志配置。

ResourceReference

对资源的引用。

ResourceSku

资源的计费信息。

ServiceSpecification

描述规范的对象。

ShareablePrivateLinkResourceProperties

描述已载入到专用链接服务的资源类型的属性

ShareablePrivateLinkResourceType

描述已载入到专用链接服务的资源类型

SharedPrivateLinkResource

描述共享专用链接资源

SharedPrivateLinkResourceList

共享专用链接资源列表

SignalRServiceUsage

描述资源的特定使用情况的对象。

SignalRServiceUsageList

包含资源使用情况数组和下一个集的可能链接的对象。

SignalRServiceUsageName

包含名称和本地化值的可本地化 String 对象。

Sku

描述可用的 SKU。

SkuCapacity

描述 SKU 的缩放信息。

SkuList

列表 SKU 操作响应

SystemData

与创建和上次修改资源相关的元数据。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UpstreamAuthSettings

上游身份验证设置。 如果未设置,则不会对上游消息使用身份验证。

Usages

表示 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

资源的网络 ACL

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 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
应用程序
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
SocketIO

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

包含 regenerateKey 操作的响应数据。

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

包含更新操作的响应数据。

枚举

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。