Condividi tramite


@azure/arm-webpubsub package

Classi

WebPubSubManagementClient

Interfacce

CustomCertificate

Un certificato personalizzato.

CustomCertificateList

Elenco di certificati personalizzati.

CustomDomain

Un dominio personalizzato

CustomDomainList

Elenco domini personalizzati

Dimension

Specifiche della dimensione delle metriche.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

EventHandler

Proprietà del gestore eventi.

EventHubEndpoint

Un endpoint dell'hub eventi. L'identità gestita del servizio Web PubSub deve essere abilitata e l'identità deve avere il ruolo "Mittente dati di Hub eventi di Azure" per accedere all'hub eventi.

EventListener

Un'impostazione definisce i tipi di eventi da inviare all'endpoint.

EventListenerEndpoint

Endpoint che specifica dove Web PubSub deve inviare eventi.

EventListenerFilter

Classe di base per il filtro eventi che determina se un evento deve essere inviato a un listener di eventi.

EventNameFilter

Filtrare gli eventi in base al nome.

IPRule

Una regola IP

LiveTraceCategory

Configurazione della categoria di traccia dinamica di una risorsa Microsoft.SignalRService.

LiveTraceConfiguration

Configurazione della traccia in tempo reale di una risorsa Microsoft.SignalRService.

LogSpecification

Specifiche dei log per il monitoraggio di Azure.

ManagedIdentity

Una classe rappresenta le identità gestite usate per la richiesta e la risposta

ManagedIdentitySettings

Impostazioni di identità gestite per upstream.

MetricSpecification

Specifiche delle metriche per il monitoraggio di Azure.

NameAvailability

Risultato della richiesta per verificare la disponibilità del nome. Contiene un flag e la possibile causa dell'errore.

NameAvailabilityParameters

Dati POST-ed nell'azione nameAvailability

NetworkACL

ACL di rete

Operation

Operazione API REST supportata dal provider di risorse.

OperationDisplay

Oggetto che descrive un'operazione.

OperationList

Risultato della richiesta per elencare le operazioni dell'API REST. Contiene un elenco di operazioni.

OperationProperties

Proprietà aggiuntive dell'operazione.

Operations

Interfaccia che rappresenta un oggetto Operations.

OperationsListNextOptionalParams

Parametri facoltativi.

OperationsListOptionalParams

Parametri facoltativi.

PrivateEndpoint

Endpoint privato

PrivateEndpointACL

ACL per un endpoint privato

PrivateEndpointConnection

Una connessione endpoint privato a una risorsa di Azure

PrivateEndpointConnectionList

Elenco di connessioni endpoint privato

PrivateLinkResource

Risorsa collegamento privato

PrivateLinkResourceList

Contiene un elenco di PrivateLinkResource e un possibile collegamento per eseguire query su altri risultati

PrivateLinkServiceConnectionState

Stato della connessione dell'endpoint privato

ProxyResource

Definizione del modello di risorse per una risorsa proxy di Azure Resource Manager. Non avrà tag e una posizione

RegenerateKeyParameters

I parametri descrivono la richiesta di rigenerazione delle chiavi di accesso

Replica

Una classe rappresenta una risorsa di replica.

ReplicaList
Resource

Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager

ResourceLogCategory

Configurazione della categoria del log delle risorse di una risorsa Microsoft.SignalRService.

ResourceLogConfiguration

Configurazione del log delle risorse di una risorsa Microsoft.SignalRService.

ResourceReference

Riferimento a una risorsa.

ResourceSku

Informazioni di fatturazione della risorsa.

ServiceSpecification

Oggetto che descrive una specifica.

ShareablePrivateLinkResourceProperties

Descrive le proprietà di un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato

ShareablePrivateLinkResourceType

Descrive un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato

SharedPrivateLinkResource

Descrive una risorsa collegamento privato condiviso

SharedPrivateLinkResourceList

Elenco di risorse di collegamento privato condiviso

SignalRServiceUsage

Oggetto che descrive un utilizzo specifico delle risorse.

SignalRServiceUsageList

Oggetto che include una matrice di utilizzi delle risorse e un possibile collegamento per il set successivo.

SignalRServiceUsageName

Oggetto String localizzabile contenente il nome e un valore localizzato.

Sku

Descrive uno SKU disponibile."

SkuCapacity

Vengono descritte le informazioni di ridimensionamento di uno SKU.

SkuList

Risposta all'operazione list skus

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TrackedResource

La definizione del modello di risorsa per una risorsa di livello superiore di Azure Resource Manager con "tag" e "location"

UpstreamAuthSettings

Impostazioni di autenticazione upstream. Se non è impostata, non viene usata alcuna autenticazione per i messaggi upstream.

Usages

Interfaccia che rappresenta un utilizzo.

UsagesListNextOptionalParams

Parametri facoltativi.

UsagesListOptionalParams

Parametri facoltativi.

UserAssignedIdentityProperty

Proprietà dell'identità assegnata dall'utente.

WebPubSub

Interfaccia che rappresenta un oggetto WebPubSub.

WebPubSubCheckNameAvailabilityOptionalParams

Parametri facoltativi.

WebPubSubCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubCustomCertificates

Interfaccia che rappresenta un oggetto WebPubSubCustomCertificates.

WebPubSubCustomCertificatesCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubCustomCertificatesDeleteOptionalParams

Parametri facoltativi.

WebPubSubCustomCertificatesGetOptionalParams

Parametri facoltativi.

WebPubSubCustomCertificatesListNextOptionalParams

Parametri facoltativi.

WebPubSubCustomCertificatesListOptionalParams

Parametri facoltativi.

WebPubSubCustomDomains

Interfaccia che rappresenta un WebPubSubCustomDomains.

WebPubSubCustomDomainsCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubCustomDomainsDeleteOptionalParams

Parametri facoltativi.

WebPubSubCustomDomainsGetOptionalParams

Parametri facoltativi.

WebPubSubCustomDomainsListNextOptionalParams

Parametri facoltativi.

WebPubSubCustomDomainsListOptionalParams

Parametri facoltativi.

WebPubSubDeleteOptionalParams

Parametri facoltativi.

WebPubSubGetOptionalParams

Parametri facoltativi.

WebPubSubHub

Un'impostazione dell'hub

WebPubSubHubList

Elenco delle impostazioni dell'hub

WebPubSubHubProperties

Proprietà di un hub.

WebPubSubHubs

Interfaccia che rappresenta un WebPubSubHubs.

WebPubSubHubsCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubHubsDeleteOptionalParams

Parametri facoltativi.

WebPubSubHubsGetOptionalParams

Parametri facoltativi.

WebPubSubHubsListNextOptionalParams

Parametri facoltativi.

WebPubSubHubsListOptionalParams

Parametri facoltativi.

WebPubSubKeys

Una classe rappresenta le chiavi di accesso della risorsa.

WebPubSubListByResourceGroupNextOptionalParams

Parametri facoltativi.

WebPubSubListByResourceGroupOptionalParams

Parametri facoltativi.

WebPubSubListBySubscriptionNextOptionalParams

Parametri facoltativi.

WebPubSubListBySubscriptionOptionalParams

Parametri facoltativi.

WebPubSubListKeysOptionalParams

Parametri facoltativi.

WebPubSubListReplicaSkusOptionalParams

Parametri facoltativi.

WebPubSubListSkusOptionalParams

Parametri facoltativi.

WebPubSubManagementClientOptionalParams

Parametri facoltativi.

WebPubSubNetworkACLs

ACL di rete per la risorsa

WebPubSubPrivateEndpointConnections

Interfaccia che rappresenta un oggetto WebPubSubPrivateEndpointConnections.

WebPubSubPrivateEndpointConnectionsDeleteOptionalParams

Parametri facoltativi.

WebPubSubPrivateEndpointConnectionsGetOptionalParams

Parametri facoltativi.

WebPubSubPrivateEndpointConnectionsListNextOptionalParams

Parametri facoltativi.

WebPubSubPrivateEndpointConnectionsListOptionalParams

Parametri facoltativi.

WebPubSubPrivateEndpointConnectionsUpdateOptionalParams

Parametri facoltativi.

WebPubSubPrivateLinkResources

Interfaccia che rappresenta un Oggetto WebPubSubPrivateLinkResources.

WebPubSubPrivateLinkResourcesListNextOptionalParams

Parametri facoltativi.

WebPubSubPrivateLinkResourcesListOptionalParams

Parametri facoltativi.

WebPubSubRegenerateKeyHeaders

Definisce le intestazioni per WebPubSub_regenerateKey operazione.

WebPubSubRegenerateKeyOptionalParams

Parametri facoltativi.

WebPubSubReplicaSharedPrivateLinkResources

Interfaccia che rappresenta un oggetto WebPubSubReplicaSharedPrivateLinkResources.

WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams

Parametri facoltativi.

WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams

Parametri facoltativi.

WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams

Parametri facoltativi.

WebPubSubReplicas

Interfaccia che rappresenta un oggetto WebPubSubReplicas.

WebPubSubReplicasCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubReplicasDeleteOptionalParams

Parametri facoltativi.

WebPubSubReplicasGetOptionalParams

Parametri facoltativi.

WebPubSubReplicasListNextOptionalParams

Parametri facoltativi.

WebPubSubReplicasListOptionalParams

Parametri facoltativi.

WebPubSubReplicasRestartHeaders

Definisce le intestazioni per l'operazione di WebPubSubReplicas_restart.

WebPubSubReplicasRestartOptionalParams

Parametri facoltativi.

WebPubSubReplicasUpdateHeaders

Definisce le intestazioni per l'operazione di WebPubSubReplicas_update.

WebPubSubReplicasUpdateOptionalParams

Parametri facoltativi.

WebPubSubResource

Una classe rappresenta una risorsa.

WebPubSubResourceList

Oggetto che include una matrice di risorse e un possibile collegamento per il set successivo.

WebPubSubRestartHeaders

Definisce le intestazioni per WebPubSub_restart'operazione.

WebPubSubRestartOptionalParams

Parametri facoltativi.

WebPubSubSharedPrivateLinkResources

Interfaccia che rappresenta un oggetto WebPubSubSharedPrivateLinkResources.

WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Parametri facoltativi.

WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams

Parametri facoltativi.

WebPubSubSharedPrivateLinkResourcesGetOptionalParams

Parametri facoltativi.

WebPubSubSharedPrivateLinkResourcesListNextOptionalParams

Parametri facoltativi.

WebPubSubSharedPrivateLinkResourcesListOptionalParams

Parametri facoltativi.

WebPubSubSocketIOSettings

Impostazioni socketIO per la risorsa

WebPubSubTlsSettings

Impostazioni TLS per la risorsa

WebPubSubUpdateHeaders

Definisce le intestazioni per l'operazione di WebPubSub_update.

WebPubSubUpdateOptionalParams

Parametri facoltativi.

Alias tipo

ACLAction

Definisce i valori per ACLAction.
KnownACLAction può essere usato in modo intercambiabile con ACLAction, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Consenti
Nega

CreatedByType

Definisce i valori per CreatedByType.
KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

utente
dell'applicazione
ManagedIdentity
chiave

EventListenerEndpointDiscriminator

Definisce i valori per EventListenerEndpointDiscriminator.
KnownEventListenerEndpointDiscriminator può essere usato in modo intercambiabile con EventListenerEndpointDiscriminator, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

EventHub

EventListenerEndpointUnion
EventListenerFilterDiscriminator

Definisce i valori per EventListenerFilterDiscriminator.
KnownEventListenerFilterDiscriminator può essere usato in modo intercambiabile con EventListenerFilterDiscriminator, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

EventName

EventListenerFilterUnion
KeyType

Definisce i valori per KeyType.
KnownKeyType può essere usato in modo intercambiabile con KeyType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

primario
secondario
salt

ManagedIdentityType

Definisce i valori per ManagedIdentityType.
KnownManagedIdentityType può essere usato in modo intercambiabile con ManagedIdentityType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuna
SystemAssigned
userAssigned

OperationsListNextResponse

Contiene i dati di risposta per l'operazione listNext.

OperationsListResponse

Contiene i dati di risposta per l'operazione di elenco.

PrivateLinkServiceConnectionStatus

Definisce i valori per PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus può essere usato in modo intercambiabile con PrivateLinkServiceConnectionStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

in sospeso
approvato
rifiutata
disconnesso

ProvisioningState

Definisce i valori per ProvisioningState.
KnownProvisioningState può essere usato in modo intercambiabile con ProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

sconosciuto
riuscito
non riuscito
annullata
In esecuzione
Creazione di
aggiornamento
eliminazione di
Spostamento

ScaleType

Definisce i valori per ScaleType.
KnownScaleType può essere usato in modo intercambiabile con ScaleType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuna
manuale
automatico

ServiceKind

Definisce i valori per ServiceKind.
KnownServiceKind può essere usato in modo intercambiabile con ServiceKind, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

WebPubSub
socketIO

SharedPrivateLinkResourceStatus

Definisce i valori per SharedPrivateLinkResourceStatus.
KnownSharedPrivateLinkResourceStatus può essere usato in modo intercambiabile con SharedPrivateLinkResourceStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

in sospeso
approvato
rifiutata
disconnesso
timeout

UpstreamAuthType

Definisce i valori per UpstreamAuthType.
KnownUpstreamAuthType può essere usato in modo intercambiabile con UpstreamAuthType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Nessuna
ManagedIdentity

UsagesListNextResponse

Contiene i dati di risposta per l'operazione listNext.

UsagesListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubCheckNameAvailabilityResponse

Contiene i dati di risposta per l'operazione checkNameAvailability.

WebPubSubCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubCustomCertificatesCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubCustomCertificatesGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubCustomCertificatesListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubCustomCertificatesListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubCustomDomainsCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubCustomDomainsGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubCustomDomainsListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubCustomDomainsListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubHubsCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubHubsGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubHubsListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubHubsListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubListByResourceGroupNextResponse

Contiene i dati di risposta per l'operazione listByResourceGroupNext.

WebPubSubListByResourceGroupResponse

Contiene i dati di risposta per l'operazione listByResourceGroup.

WebPubSubListBySubscriptionNextResponse

Contiene i dati di risposta per l'operazione listBySubscriptionNext.

WebPubSubListBySubscriptionResponse

Contiene i dati di risposta per l'operazione listBySubscription.

WebPubSubListKeysResponse

Contiene i dati di risposta per l'operazione listKeys.

WebPubSubListReplicaSkusResponse

Contiene i dati di risposta per l'operazione listReplicaSkus.

WebPubSubListSkusResponse

Contiene i dati di risposta per l'operazione listSkus.

WebPubSubPrivateEndpointConnectionsGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubPrivateEndpointConnectionsListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubPrivateEndpointConnectionsListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubPrivateEndpointConnectionsUpdateResponse

Contiene i dati di risposta per l'operazione di aggiornamento.

WebPubSubPrivateLinkResourcesListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubPrivateLinkResourcesListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubRegenerateKeyResponse

Contiene i dati di risposta per l'operazione regenerateKey.

WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubReplicaSharedPrivateLinkResourcesGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubReplicaSharedPrivateLinkResourcesListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubReplicasCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubReplicasGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubReplicasListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubReplicasListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubReplicasRestartResponse

Contiene i dati di risposta per l'operazione di riavvio.

WebPubSubReplicasUpdateResponse

Contiene i dati di risposta per l'operazione di aggiornamento.

WebPubSubRequestType

Definisce i valori per WebPubSubRequestType.
KnownWebPubSubRequestType può essere usato in modo intercambiabile con WebPubSubRequestType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

clientConnection
ServerConnection
RESTAPI
traccia

WebPubSubRestartResponse

Contiene i dati di risposta per l'operazione di riavvio.

WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse

Contiene i dati di risposta per l'operazione createOrUpdate.

WebPubSubSharedPrivateLinkResourcesGetResponse

Contiene i dati di risposta per l'operazione get.

WebPubSubSharedPrivateLinkResourcesListNextResponse

Contiene i dati di risposta per l'operazione listNext.

WebPubSubSharedPrivateLinkResourcesListResponse

Contiene i dati di risposta per l'operazione di elenco.

WebPubSubSkuTier

Definisce i valori per WebPubSubSkuTier.
KnownWebPubSubSkuTier può essere usato in modo intercambiabile con WebPubSubSkuTier, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

gratuito
Basic
standard
Premium

WebPubSubUpdateResponse

Contiene i dati di risposta per l'operazione di aggiornamento.

Enumerazioni

KnownACLAction

Valori noti di ACLAction accettati dal servizio.

KnownCreatedByType

Valori noti di CreatedByType accettati dal servizio.

KnownEventListenerEndpointDiscriminator

Valori noti di EventListenerEndpointDiscriminator accettati dal servizio.

KnownEventListenerFilterDiscriminator

Valori noti di EventListenerFilterDiscriminator accettati dal servizio.

KnownKeyType

Valori noti di KeyType accettati dal servizio.

KnownManagedIdentityType

Valori noti di ManagedIdentityType accettati dal servizio.

KnownPrivateLinkServiceConnectionStatus

Valori noti di PrivateLinkServiceConnectionStatus accettati dal servizio.

KnownProvisioningState

Valori noti di ProvisioningState accettati dal servizio.

KnownScaleType

Valori noti di ScaleType accettati dal servizio.

KnownServiceKind

Valori noti di ServiceKind accettati dal servizio.

KnownSharedPrivateLinkResourceStatus

Valori noti di SharedPrivateLinkResourceStatus accettati dal servizio.

KnownUpstreamAuthType

Valori noti di UpstreamAuthType accettati dal servizio.

KnownWebPubSubRequestType

Valori noti di WebPubSubRequestType accettati dal servizio.

KnownWebPubSubSkuTier

Valori noti di WebPubSubSkuTier accettati dal servizio.

Funzioni

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage, restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

Dettagli funzione

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage, restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

function getContinuationToken(page: unknown): string | undefined

Parametri

page

unknown

Oggetto dall'accesso a value sull'IteratorResult da un iteratore byPage.

Restituisce

string | undefined

Token di continuazione che può essere passato a byPage() durante le chiamate future.