共用方式為


@azure/arm-webpubsub package

類別

WebPubSubManagementClient

介面

CustomCertificate

自定義憑證。

CustomCertificateList

自定義憑證清單。

CustomDomain

自訂網域

CustomDomainList

自訂網域清單

Dimension

計量維度的規格。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

所有 Azure Resource Manager 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 至 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 Proxy 資源的資源模型定義。 它不會有標記和位置

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

清單 SKU 作業回應

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

資源的網路 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 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

免費
基本
Standard
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

上游AuthType 服務的已知值。

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() 的接續令牌。