@azure/arm-webpubsub package

Klasser

WebPubSubManagementClient

Gränssnitt

CustomCertificate	Ett anpassat certifikat.
CustomCertificateList	Lista över anpassade certifikat.
CustomDomain	En anpassad domän
CustomDomainList	Lista över anpassade domäner
Dimension	Specifikationer för måttdimensionen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
EventHandler	Egenskaper för händelsehanteraren.
EventHubEndpoint	En Händelsehubbslutpunkt. Den hanterade identiteten för Web PubSub-tjänsten måste vara aktiverad och identiteten ska ha rollen "Azure Event Hubs Data Sender" för att få åtkomst till Event Hub.
EventListener	En inställning definierar vilka typer av händelser som ska skickas till vilken slutpunkt.
EventListenerEndpoint	En slutpunkt som anger var Web PubSub ska skicka händelser till.
EventListenerFilter	En basklass för händelsefilter som avgör om en händelse ska skickas till en händelselyssnare.
EventNameFilter	Filtrera händelser efter deras namn.
IPRule	En IP-regel
LiveTraceCategory	Livespårningskategorikonfiguration för en Microsoft.SignalRService-resurs.
LiveTraceConfiguration	Livespårningskonfiguration av en Microsoft.SignalRService-resurs.
LogSpecification	Specifikationer för loggarna för Azure Monitoring.
ManagedIdentity	En klass representerar hanterade identiteter som används för begäran och svar
ManagedIdentitySettings	Hanterade identitetsinställningar för uppströms.
MetricSpecification	Specifikationer för måtten för Azure-övervakning.
NameAvailability	Resultatet av begäran om att kontrollera namntillgängligheten. Den innehåller en flagga och en möjlig orsak till felet.
NameAvailabilityParameters	Post-ed-data till åtgärden nameAvailability
NetworkACL	Nätverks-ACL
Operation	REST API-åtgärd som stöds av resursprovidern.
OperationDisplay	Objektet som beskriver en åtgärd.
OperationList	Resultatet av begäran om att lista REST API-åtgärder. Den innehåller en lista över åtgärder.
OperationProperties	Egenskaper för extra åtgärd.
Operations	Gränssnitt som representerar en operation.
OperationsListNextOptionalParams	Valfria parametrar.
OperationsListOptionalParams	Valfria parametrar.
PrivateEndpoint	Privat anslutningspunkt
PrivateEndpointACL	ACL för en privat slutpunkt
PrivateEndpointConnection	En privat slutpunktsanslutning till en Azure-resurs
PrivateEndpointConnectionList	En lista över privata slutpunktsanslutningar
PrivateLinkResource	Privat länkresurs
PrivateLinkResourceList	Innehåller en lista över PrivateLinkResource och en möjlig länk för att fråga efter fler resultat
PrivateLinkServiceConnectionState	Anslutningstillstånd för den privata slutpunktsanslutningen
ProxyResource	Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats
RegenerateKeyParameters	Parametrar beskriver begäran om att återskapa åtkomstnycklar
Replica	En klass representerar en replikresurs.
ReplicaList
Resource	Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser
ResourceLogCategory	Kategorikonfiguration av resurslogg för en Microsoft.SignalRService-resurs.
ResourceLogConfiguration	Konfiguration av resurslogg för en Microsoft.SignalRService-resurs.
ResourceReference	Referens till en resurs.
ResourceSku	Faktureringsinformation för resursen.
ServiceSpecification	Ett objekt som beskriver en specifikation.
ShareablePrivateLinkResourceProperties	Beskriver egenskaperna för en resurstyp som har registrerats för private link-tjänsten
ShareablePrivateLinkResourceType	Beskriver en resurstyp som har registrerats för private link-tjänsten
SharedPrivateLinkResource	Beskriver en resurs för delad privat länk
SharedPrivateLinkResourceList	En lista över resurser för delad privat länk
SignalRServiceUsage	Objekt som beskriver en specifik användning av resurserna.
SignalRServiceUsageList	Objekt som innehåller en matris med resursanvändningen och en möjlig länk för nästa uppsättning.
SignalRServiceUsageName	Localizable String-objekt som innehåller namnet och ett lokaliserat värde.
Sku	Beskriver en tillgänglig sku."
SkuCapacity	Beskriver skalningsinformation för en sku.
SkuList	Svar på list-skus-åtgärden
SystemData	Metadata som rör skapande och senaste ändring av resursen.
TrackedResource	Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"
UpstreamAuthSettings	Inställningar för överordnad autentisering. Om den inte har angetts används ingen autentisering för överordnade meddelanden.
Usages	Gränssnitt som representerar en användning.
UsagesListNextOptionalParams	Valfria parametrar.
UsagesListOptionalParams	Valfria parametrar.
UserAssignedIdentityProperty	Egenskaper för användartilldelad identitet.
WebPubSub	Gränssnitt som representerar en WebPubSub.
WebPubSubCheckNameAvailabilityOptionalParams	Valfria parametrar.
WebPubSubCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubCustomCertificates	Gränssnitt som representerar en WebPubSubCustomCertificates.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubCustomCertificatesDeleteOptionalParams	Valfria parametrar.
WebPubSubCustomCertificatesGetOptionalParams	Valfria parametrar.
WebPubSubCustomCertificatesListNextOptionalParams	Valfria parametrar.
WebPubSubCustomCertificatesListOptionalParams	Valfria parametrar.
WebPubSubCustomDomains	Gränssnitt som representerar en WebPubSubCustomDomains.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubCustomDomainsDeleteOptionalParams	Valfria parametrar.
WebPubSubCustomDomainsGetOptionalParams	Valfria parametrar.
WebPubSubCustomDomainsListNextOptionalParams	Valfria parametrar.
WebPubSubCustomDomainsListOptionalParams	Valfria parametrar.
WebPubSubDeleteOptionalParams	Valfria parametrar.
WebPubSubGetOptionalParams	Valfria parametrar.
WebPubSubHub	En hubbinställning
WebPubSubHubList	Inställningslista för hubb
WebPubSubHubProperties	Egenskaper för en hubb.
WebPubSubHubs	Gränssnitt som representerar en WebPubSubHubs.
WebPubSubHubsCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubHubsDeleteOptionalParams	Valfria parametrar.
WebPubSubHubsGetOptionalParams	Valfria parametrar.
WebPubSubHubsListNextOptionalParams	Valfria parametrar.
WebPubSubHubsListOptionalParams	Valfria parametrar.
WebPubSubKeys	En klass representerar resursens åtkomstnycklar.
WebPubSubListByResourceGroupNextOptionalParams	Valfria parametrar.
WebPubSubListByResourceGroupOptionalParams	Valfria parametrar.
WebPubSubListBySubscriptionNextOptionalParams	Valfria parametrar.
WebPubSubListBySubscriptionOptionalParams	Valfria parametrar.
WebPubSubListKeysOptionalParams	Valfria parametrar.
WebPubSubListReplicaSkusOptionalParams	Valfria parametrar.
WebPubSubListSkusOptionalParams	Valfria parametrar.
WebPubSubManagementClientOptionalParams	Valfria parametrar.
WebPubSubNetworkACLs	Nätverks-ACL:er för resursen
WebPubSubPrivateEndpointConnections	Gränssnitt som representerar en WebPubSubPrivateEndpointConnections.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams	Valfria parametrar.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Valfria parametrar.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Valfria parametrar.
WebPubSubPrivateLinkResources	Gränssnitt som representerar en WebPubSubPrivateLinkResources.
WebPubSubPrivateLinkResourcesListNextOptionalParams	Valfria parametrar.
WebPubSubPrivateLinkResourcesListOptionalParams	Valfria parametrar.
WebPubSubRegenerateKeyHeaders	Definierar rubriker för WebPubSub_regenerateKey åtgärd.
WebPubSubRegenerateKeyOptionalParams	Valfria parametrar.
WebPubSubReplicas	Gränssnitt som representerar en WebPubSubReplicas.
WebPubSubReplicasCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubReplicasDeleteOptionalParams	Valfria parametrar.
WebPubSubReplicasGetOptionalParams	Valfria parametrar.
WebPubSubReplicasListNextOptionalParams	Valfria parametrar.
WebPubSubReplicasListOptionalParams	Valfria parametrar.
WebPubSubReplicasRestartHeaders	Definierar rubriker för WebPubSubReplicas_restart åtgärd.
WebPubSubReplicasRestartOptionalParams	Valfria parametrar.
WebPubSubReplicasUpdateHeaders	Definierar rubriker för WebPubSubReplicas_update åtgärd.
WebPubSubReplicasUpdateOptionalParams	Valfria parametrar.
WebPubSubResource	En klass representerar en resurs.
WebPubSubResourceList	Objekt som innehåller en matris med resurser och en möjlig länk för nästa uppsättning.
WebPubSubRestartHeaders	Definierar rubriker för WebPubSub_restart åtgärd.
WebPubSubRestartOptionalParams	Valfria parametrar.
WebPubSubSharedPrivateLinkResources	Gränssnitt som representerar en WebPubSubSharedPrivateLinkResources.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Valfria parametrar.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Valfria parametrar.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Valfria parametrar.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams	Valfria parametrar.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Valfria parametrar.
WebPubSubTlsSettings	TLS-inställningar för resursen
WebPubSubUpdateHeaders	Definierar rubriker för WebPubSub_update åtgärd.
WebPubSubUpdateOptionalParams	Valfria parametrar.

Typalias

ACLAction	Definierar värden för ACLAction. KnownACLAction kan användas omväxlande med ACLAction innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Tillåt Neka
CreatedByType	Definierar värden för CreatedByType. KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Användare Ansökan ManagedIdentity Nyckel
EventListenerEndpointDiscriminator	Definierar värden för EventListenerEndpointDiscriminator. KnownEventListenerEndpointDiscriminator kan användas utbytbart med EventListenerEndpointDiscriminator innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten EventHub
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Definierar värden för EventListenerFilterDiscriminator. KnownEventListenerFilterDiscriminator kan användas utbytbart med EventListenerFilterDiscriminator innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten EventName
EventListenerFilterUnion
KeyType	Definierar värden för KeyType. KnownKeyType- kan användas utbytbart med KeyType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten primär Sekundär salt
ManagedIdentityType	Definierar värden för ManagedIdentityType. KnownManagedIdentityType kan användas omväxlande med ManagedIdentityType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten None SystemAssigned UserAssigned
OperationsListNextResponse	Innehåller svarsdata för listNästa åtgärden.
OperationsListResponse	Innehåller svarsdata för liståtgärden.
PrivateLinkServiceConnectionStatus	Definierar värden för PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus kan användas utbytbart med PrivateLinkServiceConnectionStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Väntande Godkänd Avvisad Frånkopplad
ProvisioningState	Definierar värden för ProvisioningState. KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Okänd lyckades Misslyckades Avbrutna Körning Skapa uppdaterar ta bort Flytta
ScaleType	Definierar värden för ScaleType. KnownScaleType- kan användas omväxlande med ScaleType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten None Manuell Automatisk
ServiceKind	Definierar värden för ServiceKind. KnownServiceKind- kan användas utbytbart med ServiceKind innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten WebPubSub SocketIO
SharedPrivateLinkResourceStatus	Definierar värden för SharedPrivateLinkResourceStatus. KnownSharedPrivateLinkResourceStatus kan användas utbytbart med SharedPrivateLinkResourceStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Väntande Godkänd Avvisad Frånkopplad Tidsgräns
UpstreamAuthType	Definierar värden för UpstreamAuthType. KnownUpstreamAuthType kan användas utbytbart med UpstreamAuthType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten None ManagedIdentity
UsagesListNextResponse	Innehåller svarsdata för listNästa åtgärden.
UsagesListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubCheckNameAvailabilityResponse	Innehåller svarsdata för åtgärden checkNameAvailability.
WebPubSubCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubCustomCertificatesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubCustomCertificatesGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubCustomCertificatesListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubCustomCertificatesListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubCustomDomainsCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubCustomDomainsGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubCustomDomainsListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubCustomDomainsListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubHubsCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubHubsGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubHubsListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubHubsListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubListByResourceGroupNextResponse	Innehåller svarsdata för åtgärden listByResourceGroupNext.
WebPubSubListByResourceGroupResponse	Innehåller svarsdata för åtgärden listByResourceGroup.
WebPubSubListBySubscriptionNextResponse	Innehåller svarsdata för åtgärden listBySubscriptionNext.
WebPubSubListBySubscriptionResponse	Innehåller svarsdata för listBySubscription-åtgärden.
WebPubSubListKeysResponse	Innehåller svarsdata för åtgärden listKeys.
WebPubSubListReplicaSkusResponse	Innehåller svarsdata för åtgärden listReplicaSkus.
WebPubSubListSkusResponse	Innehåller svarsdata för listSkus-åtgärden.
WebPubSubPrivateEndpointConnectionsGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubPrivateEndpointConnectionsListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubPrivateEndpointConnectionsListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubPrivateEndpointConnectionsUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
WebPubSubPrivateLinkResourcesListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubPrivateLinkResourcesListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubRegenerateKeyResponse	Innehåller svarsdata för åtgärden regenerateKey.
WebPubSubReplicasCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubReplicasGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubReplicasListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubReplicasListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubReplicasRestartResponse	Innehåller svarsdata för omstartsåtgärden.
WebPubSubReplicasUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
WebPubSubRequestType	Definierar värden för WebPubSubRequestType. KnownWebPubSubRequestType kan användas utbytbart med WebPubSubRequestType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten ClientConnection ServerConnection RESTAPI- Spårning
WebPubSubRestartResponse	Innehåller svarsdata för omstartsåtgärden.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
WebPubSubSharedPrivateLinkResourcesGetResponse	Innehåller svarsdata för get-åtgärden.
WebPubSubSharedPrivateLinkResourcesListNextResponse	Innehåller svarsdata för listNästa åtgärden.
WebPubSubSharedPrivateLinkResourcesListResponse	Innehåller svarsdata för liståtgärden.
WebPubSubSkuTier	Definierar värden för WebPubSubSkuTier. KnownWebPubSubSkuTier kan användas omväxlande med WebPubSubSkuTier innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Gratis Grundläggande Standard Premium
WebPubSubUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.

Uppräkningar

KnownACLAction	Kända värden för ACLAction- som tjänsten accepterar.
KnownCreatedByType	Kända värden för CreatedByType- som tjänsten accepterar.
KnownEventListenerEndpointDiscriminator	Kända värden för EventListenerEndpointDiscriminator som tjänsten accepterar.
KnownEventListenerFilterDiscriminator	Kända värden för EventListenerFilterDiscriminator som tjänsten accepterar.
KnownKeyType	Kända värden för KeyType- som tjänsten accepterar.
KnownManagedIdentityType	Kända värden för ManagedIdentityType som tjänsten accepterar.
KnownPrivateLinkServiceConnectionStatus	Kända värden för PrivateLinkServiceConnectionStatus som tjänsten accepterar.
KnownProvisioningState	Kända värden för ProvisioningState som tjänsten accepterar.
KnownScaleType	Kända värden för ScaleType- som tjänsten accepterar.
KnownServiceKind	Kända värden för ServiceKind- som tjänsten accepterar.
KnownSharedPrivateLinkResourceStatus	Kända värden för SharedPrivateLinkResourceStatus som tjänsten accepterar.
KnownUpstreamAuthType	Kända värden för UpstreamAuthType som tjänsten accepterar.
KnownWebPubSubRequestType	Kända värden för WebPubSubRequestType som tjänsten accepterar.
KnownWebPubSubSkuTier	Kända värden för WebPubSubSkuTier som tjänsten accepterar.

Funktioner

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

Funktionsinformation

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

Ett objekt från att komma åt value på IteratorResult från en byPage iterator.

Returer

string | undefined

Fortsättningstoken som kan skickas till byPage() under framtida anrop.