@azure/arm-webpubsub package

Klassen

WebPubSubManagementClient

Interfaces

CustomCertificate	Een aangepast certificaat.
CustomCertificateList	Lijst met aangepaste certificaten.
CustomDomain	Een aangepast domein
CustomDomainList	Lijst met aangepaste domeinen
Dimension	Specificaties van de dimensie van metrische gegevens.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
EventHandler	Eigenschappen van gebeurtenis-handler.
EventHubEndpoint	Een Event Hub-eindpunt. De beheerde identiteit van de Web PubSub-service moet zijn ingeschakeld en de identiteit moet de rol 'Azure Event Hubs-gegevensafzender' hebben voor toegang tot Event Hub.
EventListener	Een instelling definieert welke soorten gebeurtenissen moeten worden verzonden naar welk eindpunt.
EventListenerEndpoint	Een eindpunt dat aangeeft waar Web PubSub gebeurtenissen naartoe moet verzenden.
EventListenerFilter	Een basisklasse voor gebeurtenisfilter waarmee wordt bepaald of een gebeurtenis naar een gebeurtenislistener moet worden verzonden.
EventNameFilter	Filter gebeurtenissen op hun naam.
IPRule	Een IP-regel
LiveTraceCategory	Configuratie van livetraceringscategorie van een Microsoft.SignalRService-resource.
LiveTraceConfiguration	Live trace-configuratie van een Microsoft.SignalRService-resource.
LogSpecification	Specificaties van de logboeken voor Azure Monitoring.
ManagedIdentity	Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden
ManagedIdentitySettings	Instellingen voor beheerde identiteiten voor upstream.
MetricSpecification	Specificaties van de metrische gegevens voor Azure Monitoring.
NameAvailability	Resultaat van de aanvraag om de beschikbaarheid van de naam te controleren. Het bevat een vlag en mogelijke reden van fout.
NameAvailabilityParameters	Gegevens die zijn verzonden naar de actie NameAvailability
NetworkACL	Netwerk-ACL
Operation	REST API-bewerking die wordt ondersteund door de resourceprovider.
OperationDisplay	Het object dat een bewerking beschrijft.
OperationList	Resultaat van de aanvraag om REST API-bewerkingen weer te geven. Het bevat een lijst met bewerkingen.
OperationProperties	Extra bewerkingseigenschappen.
Operations	Interface die een bewerking vertegenwoordigt.
OperationsListNextOptionalParams	Optionele parameters.
OperationsListOptionalParams	Optionele parameters.
PrivateEndpoint	Privé-eindpunt
PrivateEndpointACL	ACL voor een privé-eindpunt
PrivateEndpointConnection	Een privé-eindpuntverbinding met een Azure-resource
PrivateEndpointConnectionList	Een lijst met privé-eindpuntverbindingen
PrivateLinkResource	Private Link-resource
PrivateLinkResourceList	Bevat een lijst met PrivateLinkResource en een mogelijke koppeling om meer resultaten op te vragen
PrivateLinkServiceConnectionState	Verbindingsstatus van de privé-eindpuntverbinding
ProxyResource	De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie
RegenerateKeyParameters	Parameters beschrijven de aanvraag voor het opnieuw genereren van toegangssleutels
Replica	Een klasse vertegenwoordigt een replicaresource.
ReplicaList
Resource	Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources
ResourceLogCategory	Resourcelogboekcategorieconfiguratie van een Microsoft.SignalRService-resource.
ResourceLogConfiguration	Configuratie van resourcelogboek van een Microsoft.SignalRService-resource.
ResourceReference	Verwijzing naar een resource.
ResourceSku	De factureringsgegevens van de resource.
ServiceSpecification	Een object dat een specificatie beschrijft.
ShareablePrivateLinkResourceProperties	Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service
ShareablePrivateLinkResourceType	Beschrijft een resourcetype dat is geïmplementeerd voor de Private Link-service
SharedPrivateLinkResource	Beschrijft een Gedeelde Private Link-resource
SharedPrivateLinkResourceList	Een lijst met gedeelde private link-resources
SignalRServiceUsage	Object dat een specifiek gebruik van de resources beschrijft.
SignalRServiceUsageList	Object met een matrix van het resourcegebruik en een mogelijke koppeling voor de volgende set.
SignalRServiceUsageName	Lokaliseerbaar tekenreeksobject met de naam en een gelokaliseerde waarde.
Sku	Beschrijft een beschikbare SKU.'
SkuCapacity	Beschrijft schaalgegevens van een sKU.
SkuList	Het antwoord van de lijst-SKU-bewerking
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TrackedResource	De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie
UpstreamAuthSettings	Upstream-verificatie-instellingen. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten.
Usages	Interface die een gebruik vertegenwoordigt.
UsagesListNextOptionalParams	Optionele parameters.
UsagesListOptionalParams	Optionele parameters.
UserAssignedIdentityProperty	Eigenschappen van door de gebruiker toegewezen identiteit.
WebPubSub	Interface die een WebPubSub vertegenwoordigt.
WebPubSubCheckNameAvailabilityOptionalParams	Optionele parameters.
WebPubSubCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubCustomCertificates	Interface die een WebPubSubCustomCertificates vertegenwoordigt.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubCustomCertificatesDeleteOptionalParams	Optionele parameters.
WebPubSubCustomCertificatesGetOptionalParams	Optionele parameters.
WebPubSubCustomCertificatesListNextOptionalParams	Optionele parameters.
WebPubSubCustomCertificatesListOptionalParams	Optionele parameters.
WebPubSubCustomDomains	Interface die een WebPubSubCustomDomains vertegenwoordigt.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubCustomDomainsDeleteOptionalParams	Optionele parameters.
WebPubSubCustomDomainsGetOptionalParams	Optionele parameters.
WebPubSubCustomDomainsListNextOptionalParams	Optionele parameters.
WebPubSubCustomDomainsListOptionalParams	Optionele parameters.
WebPubSubDeleteOptionalParams	Optionele parameters.
WebPubSubGetOptionalParams	Optionele parameters.
WebPubSubHub	Een hub-instelling
WebPubSubHubList	Lijst met hubinstellingen
WebPubSubHubProperties	Eigenschappen van een hub.
WebPubSubHubs	Interface die een WebPubSubHubs vertegenwoordigt.
WebPubSubHubsCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubHubsDeleteOptionalParams	Optionele parameters.
WebPubSubHubsGetOptionalParams	Optionele parameters.
WebPubSubHubsListNextOptionalParams	Optionele parameters.
WebPubSubHubsListOptionalParams	Optionele parameters.
WebPubSubKeys	Een klasse vertegenwoordigt de toegangssleutels van de resource.
WebPubSubListByResourceGroupNextOptionalParams	Optionele parameters.
WebPubSubListByResourceGroupOptionalParams	Optionele parameters.
WebPubSubListBySubscriptionNextOptionalParams	Optionele parameters.
WebPubSubListBySubscriptionOptionalParams	Optionele parameters.
WebPubSubListKeysOptionalParams	Optionele parameters.
WebPubSubListReplicaSkusOptionalParams	Optionele parameters.
WebPubSubListSkusOptionalParams	Optionele parameters.
WebPubSubManagementClientOptionalParams	Optionele parameters.
WebPubSubNetworkACLs	Netwerk-ACL's voor de resource
WebPubSubPrivateEndpointConnections	Interface die een WebPubSubPrivateEndpointConnections vertegenwoordigt.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Optionele parameters.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Optionele parameters.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams	Optionele parameters.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Optionele parameters.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Optionele parameters.
WebPubSubPrivateLinkResources	Interface die een WebPubSubPrivateLinkResources vertegenwoordigt.
WebPubSubPrivateLinkResourcesListNextOptionalParams	Optionele parameters.
WebPubSubPrivateLinkResourcesListOptionalParams	Optionele parameters.
WebPubSubRegenerateKeyHeaders	Definieert headers voor WebPubSub_regenerateKey bewerking.
WebPubSubRegenerateKeyOptionalParams	Optionele parameters.
WebPubSubReplicaSharedPrivateLinkResources	Interface die een WebPubSubReplicaSharedPrivateLinkResources vertegenwoordigt.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams	Optionele parameters.
WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams	Optionele parameters.
WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams	Optionele parameters.
WebPubSubReplicas	Interface die een WebPubSubReplicas vertegenwoordigt.
WebPubSubReplicasCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubReplicasDeleteOptionalParams	Optionele parameters.
WebPubSubReplicasGetOptionalParams	Optionele parameters.
WebPubSubReplicasListNextOptionalParams	Optionele parameters.
WebPubSubReplicasListOptionalParams	Optionele parameters.
WebPubSubReplicasRestartHeaders	Definieert headers voor WebPubSubReplicas_restart bewerking.
WebPubSubReplicasRestartOptionalParams	Optionele parameters.
WebPubSubReplicasUpdateHeaders	Definieert headers voor WebPubSubReplicas_update bewerking.
WebPubSubReplicasUpdateOptionalParams	Optionele parameters.
WebPubSubResource	Een klasse vertegenwoordigt een resource.
WebPubSubResourceList	Object met een matrix met resources en een mogelijke koppeling voor de volgende set.
WebPubSubRestartHeaders	Definieert headers voor WebPubSub_restart bewerking.
WebPubSubRestartOptionalParams	Optionele parameters.
WebPubSubSharedPrivateLinkResources	Interface die een WebPubSubSharedPrivateLinkResources vertegenwoordigt.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optionele parameters.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Optionele parameters.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Optionele parameters.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams	Optionele parameters.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Optionele parameters.
WebPubSubSocketIOSettings	SocketIO-instellingen voor de resource
WebPubSubTlsSettings	TLS-instellingen voor de resource
WebPubSubUpdateHeaders	Definieert headers voor WebPubSub_update bewerking.
WebPubSubUpdateOptionalParams	Optionele parameters.

Type-aliassen

ACLAction	Definieert waarden voor ACLAction. KnownACLAction kan door elkaar worden gebruikt met ACLAction, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund toestaan weigeren
CreatedByType	Definieert waarden voor CreatedByType. KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund gebruikers toepassings- ManagedIdentity- Sleutel
EventListenerEndpointDiscriminator	Definieert waarden voor EventListenerEndpointDiscriminator. KnownEventListenerEndpointDiscriminator kan door elkaar worden gebruikt met EventListenerEndpointDiscriminator, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund EventHub-
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Definieert waarden voor EventListenerFilterDiscriminator. KnownEventListenerFilterDiscriminator kan door elkaar worden gebruikt met EventListenerFilterDiscriminator, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund EventName-
EventListenerFilterUnion
KeyType	Definieert waarden voor KeyType. KnownKeyType- kan door elkaar worden gebruikt met KeyType, bevat deze opsomming de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund primaire secundaire Zout
ManagedIdentityType	Definieert waarden voor ManagedIdentityType. KnownManagedIdentityType kan door elkaar worden gebruikt met ManagedIdentityType, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Geen SystemAssigned UserAssigned
OperationsListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
OperationsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
PrivateLinkServiceConnectionStatus	Definieert waarden voor PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus kan door elkaar worden gebruikt met PrivateLinkServiceConnectionStatus, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund in behandeling goedgekeurd geweigerde verbroken
ProvisioningState	Definieert waarden voor ProvisioningState. KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund onbekende geslaagde mislukte geannuleerde uitvoeren maken van bijwerken verwijderen verplaatsen van
ScaleType	Definieert waarden voor ScaleType. KnownScaleType- kan door elkaar worden gebruikt met ScaleType, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Geen Handmatige Automatische
ServiceKind	Definieert waarden voor ServiceKind. KnownServiceKind kan door elkaar worden gebruikt met ServiceKind, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund WebPubSub SocketIO-
SharedPrivateLinkResourceStatus	Definieert waarden voor SharedPrivateLinkResourceStatus. KnownSharedPrivateLinkResourceStatus kan door elkaar worden gebruikt met SharedPrivateLinkResourceStatus, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund in behandeling goedgekeurd geweigerde verbroken time-out
UpstreamAuthType	Definieert waarden voor UpstreamAuthType. KnownUpstreamAuthType kan door elkaar worden gebruikt met UpstreamAuthType, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Geen ManagedIdentity-
UsagesListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
UsagesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubCheckNameAvailabilityResponse	Bevat antwoordgegevens voor de bewerking checkNameAvailability.
WebPubSubCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubCustomCertificatesCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubCustomCertificatesGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubCustomCertificatesListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubCustomCertificatesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubCustomDomainsCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubCustomDomainsGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubCustomDomainsListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubCustomDomainsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubHubsCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubHubsGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubHubsListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubHubsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubListByResourceGroupNextResponse	Bevat antwoordgegevens voor de bewerking listByResourceGroupNext.
WebPubSubListByResourceGroupResponse	Bevat antwoordgegevens voor de bewerking listByResourceGroup.
WebPubSubListBySubscriptionNextResponse	Bevat antwoordgegevens voor de bewerking listBySubscriptionNext.
WebPubSubListBySubscriptionResponse	Bevat antwoordgegevens voor de listBySubscription-bewerking.
WebPubSubListKeysResponse	Bevat antwoordgegevens voor de bewerking listKeys.
WebPubSubListReplicaSkusResponse	Bevat antwoordgegevens voor de bewerking listReplicaSkus.
WebPubSubListSkusResponse	Bevat antwoordgegevens voor de listSkus-bewerking.
WebPubSubPrivateEndpointConnectionsGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubPrivateEndpointConnectionsListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubPrivateEndpointConnectionsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubPrivateEndpointConnectionsUpdateResponse	Bevat antwoordgegevens voor de updatebewerking.
WebPubSubPrivateLinkResourcesListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubPrivateLinkResourcesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubRegenerateKeyResponse	Bevat antwoordgegevens voor de bewerking regenerateKey.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubReplicaSharedPrivateLinkResourcesGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubReplicaSharedPrivateLinkResourcesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubReplicasCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubReplicasGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubReplicasListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubReplicasListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubReplicasRestartResponse	Bevat antwoordgegevens voor de herstartbewerking.
WebPubSubReplicasUpdateResponse	Bevat antwoordgegevens voor de updatebewerking.
WebPubSubRequestType	Definieert waarden voor WebPubSubRequestType. KnownWebPubSubRequestType kan door elkaar worden gebruikt met WebPubSubRequestType, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund ClientConnection- ServerConnection- RESTAPI- tracering
WebPubSubRestartResponse	Bevat antwoordgegevens voor de herstartbewerking.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse	Bevat antwoordgegevens voor de createOrUpdate-bewerking.
WebPubSubSharedPrivateLinkResourcesGetResponse	Bevat antwoordgegevens voor de get-bewerking.
WebPubSubSharedPrivateLinkResourcesListNextResponse	Bevat antwoordgegevens voor de listNext-bewerking.
WebPubSubSharedPrivateLinkResourcesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
WebPubSubSkuTier	Definieert waarden voor WebPubSubSkuTier. KnownWebPubSubSkuTier kan door elkaar worden gebruikt met WebPubSubSkuTier, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Gratis Basic- Standard- Premium-
WebPubSubUpdateResponse	Bevat antwoordgegevens voor de updatebewerking.

Enums

KnownACLAction	Bekende waarden van ACLAction die de service accepteert.
KnownCreatedByType	Bekende waarden van CreatedByType die de service accepteert.
KnownEventListenerEndpointDiscriminator	Bekende waarden van EventListenerEndpointDiscriminator die de service accepteert.
KnownEventListenerFilterDiscriminator	Bekende waarden van EventListenerFilterDiscriminator die de service accepteert.
KnownKeyType	Bekende waarden van KeyType die de service accepteert.
KnownManagedIdentityType	Bekende waarden van ManagedIdentityType die de service accepteert.
KnownPrivateLinkServiceConnectionStatus	Bekende waarden van PrivateLinkServiceConnectionStatus die de service accepteert.
KnownProvisioningState	Bekende waarden van ProvisioningState die de service accepteert.
KnownScaleType	Bekende waarden van ScaleType die de service accepteert.
KnownServiceKind	Bekende waarden van ServiceKind die de service accepteert.
KnownSharedPrivateLinkResourceStatus	Bekende waarden van SharedPrivateLinkResourceStatus die de service accepteert.
KnownUpstreamAuthType	Bekende waarden van UpstreamAuthType die de service accepteert.
KnownWebPubSubRequestType	Bekende waarden van WebPubSubRequestType die de service accepteert.
KnownWebPubSubSkuTier	Bekende waarden van WebPubSubSkuTier die de service accepteert.

Functies

getContinuationToken(unknown)

Gezien de laatste .value geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Gezien de laatste .value geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object opent value op iteratorResult vanuit een byPage iterator.

Retouren

string | undefined

Het vervolgtoken dat kan worden doorgegeven aan ByPage() tijdens toekomstige aanroepen.