@azure/arm-webpubsub package

Třídy

WebPubSubManagementClient

Rozhraní

CustomCertificate	Vlastní certifikát.
CustomCertificateList	Seznam vlastních certifikátů
CustomDomain	Vlastní doména
CustomDomainList	Seznam vlastních domén
Dimension	Specifikace dimenze metrik.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
EventHandler	Vlastnosti obslužné rutiny události
EventHubEndpoint	Koncový bod centra událostí. Spravovaná identita služby Web PubSub musí být povolená a identita by měla mít pro přístup k centru událostí roli Odesílatel dat služby Azure Event Hubs.
EventListener	Nastavení definuje, které druhy událostí se mají odesílat do kterého koncového bodu.
EventListenerEndpoint	Koncový bod určující, kam má web pubSub odesílat události.
EventListenerFilter	Základní třída pro filtr událostí, která určuje, zda má být událost odeslána do naslouchacího procesu událostí.
EventNameFilter	Vyfiltrujte události podle jejich názvu.
IPRule	Pravidlo PROTOKOLU IP
LiveTraceCategory	Konfigurace kategorie živého trasování prostředku Microsoft.SignalRService
LiveTraceConfiguration	Konfigurace živého trasování prostředku Microsoft.SignalRService
LogSpecification	Specifikace protokolů pro monitorování Azure
ManagedIdentity	Třída představuje spravované identity používané pro požadavek a odpověď.
ManagedIdentitySettings	Nastavení spravované identity pro upstream.
MetricSpecification	Specifikace metrik pro monitorování Azure
NameAvailability	Výsledek požadavku na kontrolu dostupnosti názvu Obsahuje příznak a možný důvod selhání.
NameAvailabilityParameters	Data post-ed na akci nameAvailability
NetworkACL	Seznam ACL sítě
Operation	Operace rozhraní REST API podporovaná poskytovatelem prostředků
OperationDisplay	Objekt, který popisuje operaci.
OperationList	Výsledek požadavku na výpis operací rozhraní REST API Obsahuje seznam operací.
OperationProperties	Vlastnosti operace navíc.
Operations	Rozhraní představující operace
OperationsListNextOptionalParams	Volitelné parametry.
OperationsListOptionalParams	Volitelné parametry.
PrivateEndpoint	Privátní koncový bod
PrivateEndpointACL	Seznam ACL privátního koncového bodu
PrivateEndpointConnection	Připojení privátního koncového bodu k prostředku Azure
PrivateEndpointConnectionList	Seznam připojení privátních koncových bodů
PrivateLinkResource	Prostředek Private Link
PrivateLinkResourceList	Obsahuje seznam PrivateLinkResource a možný odkaz na dotazování dalších výsledků.
PrivateLinkServiceConnectionState	Stav připojení připojení privátního koncového bodu
ProxyResource	Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.
RegenerateKeyParameters	Parametry popisují požadavek na opětovné generování přístupových klíčů.
Replica	Třída představuje prostředek repliky.
ReplicaList
Resource	Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru
ResourceLogCategory	Konfigurace kategorie protokolu prostředků prostředku Microsoft.SignalRService
ResourceLogConfiguration	Konfigurace protokolu prostředků prostředku Microsoft.SignalRService
ResourceReference	Odkaz na prostředek
ResourceSku	Fakturační údaje o prostředku.
ServiceSpecification	Objekt, který popisuje specifikaci.
ShareablePrivateLinkResourceProperties	Popisuje vlastnosti typu prostředku, který byl onboardován do služby private link.
ShareablePrivateLinkResourceType	Popisuje typ prostředku, který byl onboardován do služby private link.
SharedPrivateLinkResource	Popisuje sdílený prostředek private linku.
SharedPrivateLinkResourceList	Seznam sdílených prostředků privátního propojení
SignalRServiceUsage	Objekt, který popisuje konkrétní využití prostředků.
SignalRServiceUsageList	Objekt, který obsahuje pole využití prostředků a možné propojení pro další sadu
SignalRServiceUsageName	Lokalizovatelný objekt String obsahující název a lokalizovanou hodnotu.
Sku	Popisuje dostupnou skladovou položku.
SkuCapacity	Popisuje informace o škálování skladové položky.
SkuList	Odpověď operace výpisu skladových položek
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
TrackedResource	Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.
UpstreamAuthSettings	Upstream nastavení ověřování Pokud není nastavené, pro upstreamové zprávy se nepoužívá žádné ověřování.
Usages	Rozhraní představující využití
UsagesListNextOptionalParams	Volitelné parametry.
UsagesListOptionalParams	Volitelné parametry.
UserAssignedIdentityProperty	Vlastnosti identity přiřazené uživatelem
WebPubSub	Rozhraní představující WebPubSub.
WebPubSubCheckNameAvailabilityOptionalParams	Volitelné parametry.
WebPubSubCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubCustomCertificates	Rozhraní představující WebPubSubCustomCertificates.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubCustomCertificatesDeleteOptionalParams	Volitelné parametry.
WebPubSubCustomCertificatesGetOptionalParams	Volitelné parametry.
WebPubSubCustomCertificatesListNextOptionalParams	Volitelné parametry.
WebPubSubCustomCertificatesListOptionalParams	Volitelné parametry.
WebPubSubCustomDomains	Rozhraní představující WebPubSubCustomDomains.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubCustomDomainsDeleteOptionalParams	Volitelné parametry.
WebPubSubCustomDomainsGetOptionalParams	Volitelné parametry.
WebPubSubCustomDomainsListNextOptionalParams	Volitelné parametry.
WebPubSubCustomDomainsListOptionalParams	Volitelné parametry.
WebPubSubDeleteOptionalParams	Volitelné parametry.
WebPubSubGetOptionalParams	Volitelné parametry.
WebPubSubHub	Nastavení centra
WebPubSubHubList	Seznam nastavení centra
WebPubSubHubProperties	Vlastnosti centra
WebPubSubHubs	Rozhraní představující WebPubSubHubs
WebPubSubHubsCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubHubsDeleteOptionalParams	Volitelné parametry.
WebPubSubHubsGetOptionalParams	Volitelné parametry.
WebPubSubHubsListNextOptionalParams	Volitelné parametry.
WebPubSubHubsListOptionalParams	Volitelné parametry.
WebPubSubKeys	Třída představuje přístupové klíče prostředku.
WebPubSubListByResourceGroupNextOptionalParams	Volitelné parametry.
WebPubSubListByResourceGroupOptionalParams	Volitelné parametry.
WebPubSubListBySubscriptionNextOptionalParams	Volitelné parametry.
WebPubSubListBySubscriptionOptionalParams	Volitelné parametry.
WebPubSubListKeysOptionalParams	Volitelné parametry.
WebPubSubListReplicaSkusOptionalParams	Volitelné parametry.
WebPubSubListSkusOptionalParams	Volitelné parametry.
WebPubSubManagementClientOptionalParams	Volitelné parametry.
WebPubSubNetworkACLs	Seznamy ACL sítě pro prostředek
WebPubSubPrivateEndpointConnections	Rozhraní představující WebPubSubPrivateEndpointConnections.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Volitelné parametry.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Volitelné parametry.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams	Volitelné parametry.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Volitelné parametry.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Volitelné parametry.
WebPubSubPrivateLinkResources	Rozhraní představující WebPubSubPrivateLinkResources.
WebPubSubPrivateLinkResourcesListNextOptionalParams	Volitelné parametry.
WebPubSubPrivateLinkResourcesListOptionalParams	Volitelné parametry.
WebPubSubRegenerateKeyHeaders	Definuje hlavičky pro operaci WebPubSub_regenerateKey.
WebPubSubRegenerateKeyOptionalParams	Volitelné parametry.
WebPubSubReplicaSharedPrivateLinkResources	Rozhraní představující WebPubSubReplicaSharedPrivateLinkResources
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams	Volitelné parametry.
WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams	Volitelné parametry.
WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams	Volitelné parametry.
WebPubSubReplicas	Rozhraní představující WebPubSubReplicas.
WebPubSubReplicasCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubReplicasDeleteOptionalParams	Volitelné parametry.
WebPubSubReplicasGetOptionalParams	Volitelné parametry.
WebPubSubReplicasListNextOptionalParams	Volitelné parametry.
WebPubSubReplicasListOptionalParams	Volitelné parametry.
WebPubSubReplicasRestartHeaders	Definuje hlavičky pro operaci WebPubSubReplicas_restart.
WebPubSubReplicasRestartOptionalParams	Volitelné parametry.
WebPubSubReplicasUpdateHeaders	Definuje hlavičky pro operaci WebPubSubReplicas_update.
WebPubSubReplicasUpdateOptionalParams	Volitelné parametry.
WebPubSubResource	Třída představuje prostředek.
WebPubSubResourceList	Objekt, který obsahuje pole prostředků a možné propojení pro další sadu
WebPubSubRestartHeaders	Definuje hlavičky pro operaci WebPubSub_restart.
WebPubSubRestartOptionalParams	Volitelné parametry.
WebPubSubSharedPrivateLinkResources	Rozhraní představující WebPubSubSharedPrivateLinkResources
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Volitelné parametry.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Volitelné parametry.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Volitelné parametry.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams	Volitelné parametry.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Volitelné parametry.
WebPubSubSocketIOSettings	Nastavení SocketIO pro prostředek
WebPubSubTlsSettings	Nastavení protokolu TLS pro prostředek
WebPubSubUpdateHeaders	Definuje hlavičky pro operaci WebPubSub_update.
WebPubSubUpdateOptionalParams	Volitelné parametry.

Aliasy typu

ACLAction	Definuje hodnoty pro ACLAction. PoleACLAction lze použít zaměnitelně s ACLAction, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Povolit Odepřít
CreatedByType	Definuje hodnoty pro CreatedByType. PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou uživatele aplikace ManagedIdentity klíč
EventListenerEndpointDiscriminator	Definuje hodnoty pro EventListenerEndpoint Defineor. PoleEventListenerEndpoint Diskriminor lze použít zaměnitelně s EventListenerEndpoint Diskriminor, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou eventhubu
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Definuje hodnoty pro EventListenerFilter Defineor. PoleEventListenerFilterFileterFileor lze použít zaměnitelně s EventListenerFilter Scalablor, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou eventName
EventListenerFilterUnion
KeyType	Definuje hodnoty pro KeyType. PoleKeyType lze použít zaměnitelně s typem KeyType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou primární sekundární salt
ManagedIdentityType	Definuje hodnoty pro ManagedIdentityType. PoleManagedIdentityType lze použít zaměnitelně s ManagedIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné systemAssigned přiřazené uživatelem
OperationsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
OperationsListResponse	Obsahuje data odpovědí pro operaci seznamu.
PrivateLinkServiceConnectionStatus	Definuje hodnoty pro PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus lze použít zaměnitelně s PrivateLinkServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou čekající schválené odmítnuté odpojené
ProvisioningState	Definuje hodnoty pro ProvisioningState. KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Neznámé úspěšné selhalo Zrušené spuštěné vytváření Aktualizace odstranění přesouvání
ScaleType	Definuje hodnoty pro ScaleType. pole KnownScaleType lze použít zaměnitelně s typem ScaleType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné ruční Automatické
ServiceKind	Definuje hodnoty pro ServiceKind. KnownServiceKind lze použít zaměnitelně s ServiceKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou WebPubSub SocketIO
SharedPrivateLinkResourceStatus	Definuje hodnoty pro SharedPrivateLinkResourceStatus. PoleSharedPrivateLinkResourceStatus lze použít zaměnitelně se sharedPrivateLinkResourceStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou čekající schválené odmítnuté odpojené vypršení časového limitu
UpstreamAuthType	Definuje hodnoty pro UpstreamAuthType. PoleUpstreamAuthType lze použít zaměnitelně s UpstreamAuthType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné ManagedIdentity
UsagesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
UsagesListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubCheckNameAvailabilityResponse	Obsahuje data odpovědí pro operaci checkNameAvailability.
WebPubSubCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubCustomCertificatesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubCustomCertificatesGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubCustomCertificatesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubCustomCertificatesListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubCustomDomainsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubCustomDomainsGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubCustomDomainsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubCustomDomainsListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubHubsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubHubsGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubHubsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubHubsListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubListByResourceGroupNextResponse	Obsahuje data odpovědi pro operaci listByResourceGroupNext.
WebPubSubListByResourceGroupResponse	Obsahuje data odpovědi pro operaci listByResourceGroup.
WebPubSubListBySubscriptionNextResponse	Obsahuje data odpovědi pro operaci listBySubscriptionNext.
WebPubSubListBySubscriptionResponse	Obsahuje data odpovědi pro operaci listBySubscription.
WebPubSubListKeysResponse	Obsahuje data odpovědí pro operaci listKeys.
WebPubSubListReplicaSkusResponse	Obsahuje data odpovědi pro operaci listReplicaSkus.
WebPubSubListSkusResponse	Obsahuje data odpovědí pro operaci listSkus.
WebPubSubPrivateEndpointConnectionsGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubPrivateEndpointConnectionsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubPrivateEndpointConnectionsListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubPrivateEndpointConnectionsUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.
WebPubSubPrivateLinkResourcesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubPrivateLinkResourcesListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubRegenerateKeyResponse	Obsahuje data odpovědi pro operaci regenerateKey.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubReplicaSharedPrivateLinkResourcesGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubReplicaSharedPrivateLinkResourcesListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubReplicasCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubReplicasGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubReplicasListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubReplicasListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubReplicasRestartResponse	Obsahuje data odpovědí pro operaci restartování.
WebPubSubReplicasUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.
WebPubSubRequestType	Definuje hodnoty pro WebPubSubRequestType. PoleWebPubSubRequestType lze použít zaměnitelně s WebPubSubRequestType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou ClientConnection ServerConnection RESTAPI trasování
WebPubSubRestartResponse	Obsahuje data odpovědí pro operaci restartování.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WebPubSubSharedPrivateLinkResourcesGetResponse	Obsahuje data odpovědí pro operaci get.
WebPubSubSharedPrivateLinkResourcesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WebPubSubSharedPrivateLinkResourcesListResponse	Obsahuje data odpovědí pro operaci seznamu.
WebPubSubSkuTier	Definuje hodnoty pro WebPubSubSkuTier. PoleWebPubSubSkuTier lze použít zaměnitelně s WebPubSubSkuTier, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou bezplatné Basic Standard Premium
WebPubSubUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.

Výčty

KnownACLAction	Známé hodnoty ACLAction, které služba přijímá.
KnownCreatedByType	Známé hodnoty CreatedByType, které služba přijímá.
KnownEventListenerEndpointDiscriminator	Známé hodnoty EventListenerEndpointValueor, které služba přijímá.
KnownEventListenerFilterDiscriminator	Známé hodnoty EventListenerFilterValueor, které služba přijímá.
KnownKeyType	Známé hodnoty KeyType, které služba přijímá.
KnownManagedIdentityType	Známé hodnoty ManagedIdentityType, které služba přijímá.
KnownPrivateLinkServiceConnectionStatus	Známé hodnoty PrivateLinkServiceConnectionStatus, které služba přijímá.
KnownProvisioningState	Známé hodnoty ProvisioningState, které služba přijímá.
KnownScaleType	Známé hodnoty ScaleType, které služba přijímá.
KnownServiceKind	Známé hodnoty ServiceKind, které služba přijímá.
KnownSharedPrivateLinkResourceStatus	Známé hodnoty SharedPrivateLinkResourceStatus, které služba přijímá.
KnownUpstreamAuthType	Známé hodnoty UpstreamAuthType, které služba přijímá.
KnownWebPubSubRequestType	Známé hodnoty WebPubSubRequestType, které služba přijímá.
KnownWebPubSubSkuTier	Známé hodnoty WebPubSubSkuTier, které služba přijímá.

Funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

Podrobnosti funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Objekt z přístupu k value na IteratorResult z byPage iterátoru.

Návraty

string | undefined

Token pokračování, který lze předat do byPage() během budoucích volání.