Partager via


@azure/arm-webpubsub package

Classes

WebPubSubManagementClient

Interfaces

CustomCertificate

Un certificat personnalisé.

CustomCertificateList

Liste des certificats personnalisés.

CustomDomain

Un domaine personnalisé

CustomDomainList

Liste des domaines personnalisés

Dimension

Spécifications de la dimension des métriques.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

EventHandler

Propriétés du gestionnaire d’événements.

EventHubEndpoint

Point de terminaison Event Hub. L’identité managée du service Web PubSub doit être activée et l’identité doit avoir le rôle « Expéditeur de données Azure Event Hubs » pour accéder à Event Hub.

EventListener

Un paramètre définit les types d’événements à envoyer au point de terminaison.

EventListenerEndpoint

Point de terminaison spécifiant où Web PubSub doit envoyer des événements.

EventListenerFilter

Classe de base pour le filtre d’événements qui détermine si un événement doit être envoyé à un écouteur d’événements.

EventNameFilter

Filtrez les événements par leur nom.

IPRule

Une règle IP

LiveTraceCategory

Configuration de catégorie de trace dynamique d’une ressource Microsoft.SignalRService.

LiveTraceConfiguration

Configuration de trace dynamique d’une ressource Microsoft.SignalRService.

LogSpecification

Spécifications des journaux d’activité pour la supervision Azure.

ManagedIdentity

Une classe représente les identités managées utilisées pour la demande et la réponse

ManagedIdentitySettings

Paramètres d’identité managée pour l’amont.

MetricSpecification

Spécifications des métriques pour la supervision Azure.

NameAvailability

Résultat de la demande pour vérifier la disponibilité du nom. Il contient un indicateur et la raison possible de l’échec.

NameAvailabilityParameters

Données POST-ed à l’action nameAvailability

NetworkACL

Liste de contrôle d’accès réseau

Operation

Opération d’API REST prise en charge par le fournisseur de ressources.

OperationDisplay

Objet qui décrit une opération.

OperationList

Résultat de la requête pour répertorier les opérations de l’API REST. Il contient une liste d’opérations.

OperationProperties

Propriétés d’opération supplémentaires.

Operations

Interface représentant une opération.

OperationsListNextOptionalParams

Paramètres facultatifs.

OperationsListOptionalParams

Paramètres facultatifs.

PrivateEndpoint

Point de terminaison privé

PrivateEndpointACL

ACL pour un point de terminaison privé

PrivateEndpointConnection

Connexion de point de terminaison privé à une ressource Azure

PrivateEndpointConnectionList

Liste des connexions de point de terminaison privé

PrivateLinkResource

Ressource private link

PrivateLinkResourceList

Contient une liste de PrivateLinkResource et un lien possible pour interroger d’autres résultats

PrivateLinkServiceConnectionState

État de connexion de la connexion de point de terminaison privé

ProxyResource

Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement

RegenerateKeyParameters

Les paramètres décrivent la demande de régénérer les clés d’accès

Replica

Une classe représente une ressource de réplica.

ReplicaList
Resource

Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager

ResourceLogCategory

Configuration de catégorie de journal des ressources d’une ressource Microsoft.SignalRService.

ResourceLogConfiguration

Configuration du journal des ressources d’une ressource Microsoft.SignalRService.

ResourceReference

Référence à une ressource.

ResourceSku

Informations de facturation de la ressource.

ServiceSpecification

Objet qui décrit une spécification.

ShareablePrivateLinkResourceProperties

Décrit les propriétés d’un type de ressource qui a été intégré au service de liaison privée

ShareablePrivateLinkResourceType

Décrit un type de ressource intégré au service private link

SharedPrivateLinkResource

Décrit une ressource de liaison privée partagée

SharedPrivateLinkResourceList

Liste des ressources de liaison privée partagées

SignalRServiceUsage

Objet qui décrit une utilisation spécifique des ressources.

SignalRServiceUsageList

Objet qui inclut un tableau des utilisations des ressources et un lien possible pour le jeu suivant.

SignalRServiceUsageName

Objet String localisable contenant le nom et une valeur localisée.

Sku

Décrit une référence SKU disponible. »

SkuCapacity

Décrit les informations de mise à l’échelle d’une référence SKU.

SkuList

Réponse de l’opération de référence sku de liste

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TrackedResource

Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »

UpstreamAuthSettings

Paramètres d’authentification en amont. Si ce n’est pas défini, aucune authentification n’est utilisée pour les messages en amont.

Usages

Interface représentant une utilisation.

UsagesListNextOptionalParams

Paramètres facultatifs.

UsagesListOptionalParams

Paramètres facultatifs.

UserAssignedIdentityProperty

Propriétés de l’identité affectée par l’utilisateur.

WebPubSub

Interface représentant un WebPubSub.

WebPubSubCheckNameAvailabilityOptionalParams

Paramètres facultatifs.

WebPubSubCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubCustomCertificates

Interface représentant un WebPubSubCustomCertificates.

WebPubSubCustomCertificatesCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubCustomCertificatesDeleteOptionalParams

Paramètres facultatifs.

WebPubSubCustomCertificatesGetOptionalParams

Paramètres facultatifs.

WebPubSubCustomCertificatesListNextOptionalParams

Paramètres facultatifs.

WebPubSubCustomCertificatesListOptionalParams

Paramètres facultatifs.

WebPubSubCustomDomains

Interface représentant un WebPubSubCustomDomains.

WebPubSubCustomDomainsCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubCustomDomainsDeleteOptionalParams

Paramètres facultatifs.

WebPubSubCustomDomainsGetOptionalParams

Paramètres facultatifs.

WebPubSubCustomDomainsListNextOptionalParams

Paramètres facultatifs.

WebPubSubCustomDomainsListOptionalParams

Paramètres facultatifs.

WebPubSubDeleteOptionalParams

Paramètres facultatifs.

WebPubSubGetOptionalParams

Paramètres facultatifs.

WebPubSubHub

Paramètre hub

WebPubSubHubList

Liste des paramètres du hub

WebPubSubHubProperties

Propriétés d’un hub.

WebPubSubHubs

Interface représentant un WebPubSubHubs.

WebPubSubHubsCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubHubsDeleteOptionalParams

Paramètres facultatifs.

WebPubSubHubsGetOptionalParams

Paramètres facultatifs.

WebPubSubHubsListNextOptionalParams

Paramètres facultatifs.

WebPubSubHubsListOptionalParams

Paramètres facultatifs.

WebPubSubKeys

Une classe représente les clés d’accès de la ressource.

WebPubSubListByResourceGroupNextOptionalParams

Paramètres facultatifs.

WebPubSubListByResourceGroupOptionalParams

Paramètres facultatifs.

WebPubSubListBySubscriptionNextOptionalParams

Paramètres facultatifs.

WebPubSubListBySubscriptionOptionalParams

Paramètres facultatifs.

WebPubSubListKeysOptionalParams

Paramètres facultatifs.

WebPubSubListReplicaSkusOptionalParams

Paramètres facultatifs.

WebPubSubListSkusOptionalParams

Paramètres facultatifs.

WebPubSubManagementClientOptionalParams

Paramètres facultatifs.

WebPubSubNetworkACLs

Listes de contrôle d’accès réseau pour la ressource

WebPubSubPrivateEndpointConnections

Interface représentant un WebPubSubPrivateEndpointConnections.

WebPubSubPrivateEndpointConnectionsDeleteOptionalParams

Paramètres facultatifs.

WebPubSubPrivateEndpointConnectionsGetOptionalParams

Paramètres facultatifs.

WebPubSubPrivateEndpointConnectionsListNextOptionalParams

Paramètres facultatifs.

WebPubSubPrivateEndpointConnectionsListOptionalParams

Paramètres facultatifs.

WebPubSubPrivateEndpointConnectionsUpdateOptionalParams

Paramètres facultatifs.

WebPubSubPrivateLinkResources

Interface représentant un WebPubSubPrivateLinkResources.

WebPubSubPrivateLinkResourcesListNextOptionalParams

Paramètres facultatifs.

WebPubSubPrivateLinkResourcesListOptionalParams

Paramètres facultatifs.

WebPubSubRegenerateKeyHeaders

Définit des en-têtes pour l’opération de WebPubSub_regenerateKey.

WebPubSubRegenerateKeyOptionalParams

Paramètres facultatifs.

WebPubSubReplicaSharedPrivateLinkResources

Interface représentant un WebPubSubReplicaSharedPrivateLinkResources.

WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams

Paramètres facultatifs.

WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams

Paramètres facultatifs.

WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams

Paramètres facultatifs.

WebPubSubReplicas

Interface représentant un WebPubSubReplicas.

WebPubSubReplicasCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubReplicasDeleteOptionalParams

Paramètres facultatifs.

WebPubSubReplicasGetOptionalParams

Paramètres facultatifs.

WebPubSubReplicasListNextOptionalParams

Paramètres facultatifs.

WebPubSubReplicasListOptionalParams

Paramètres facultatifs.

WebPubSubReplicasRestartHeaders

Définit des en-têtes pour l’opération de WebPubSubReplicas_restart.

WebPubSubReplicasRestartOptionalParams

Paramètres facultatifs.

WebPubSubReplicasUpdateHeaders

Définit des en-têtes pour l’opération WebPubSubReplicas_update.

WebPubSubReplicasUpdateOptionalParams

Paramètres facultatifs.

WebPubSubResource

Une classe représente une ressource.

WebPubSubResourceList

Objet qui inclut un tableau de ressources et un lien possible pour le jeu suivant.

WebPubSubRestartHeaders

Définit des en-têtes pour l’opération WebPubSub_restart.

WebPubSubRestartOptionalParams

Paramètres facultatifs.

WebPubSubSharedPrivateLinkResources

Interface représentant un WebPubSubSharedPrivateLinkResources.

WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Paramètres facultatifs.

WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams

Paramètres facultatifs.

WebPubSubSharedPrivateLinkResourcesGetOptionalParams

Paramètres facultatifs.

WebPubSubSharedPrivateLinkResourcesListNextOptionalParams

Paramètres facultatifs.

WebPubSubSharedPrivateLinkResourcesListOptionalParams

Paramètres facultatifs.

WebPubSubSocketIOSettings

Paramètres SocketIO pour la ressource

WebPubSubTlsSettings

Paramètres TLS de la ressource

WebPubSubUpdateHeaders

Définit des en-têtes pour l’opération de WebPubSub_update.

WebPubSubUpdateOptionalParams

Paramètres facultatifs.

Alias de type

ACLAction

Définit des valeurs pour ACLAction.
KnownACLAction peut être utilisé de manière interchangeable avec ACLAction, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Autoriser
Refuser

CreatedByType

Définit des valeurs pour CreatedByType.
KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

utilisateur
application
managedIdentity
clé

EventListenerEndpointDiscriminator

Définit des valeurs pour EventListenerEndpointDiscriminator.
KnownEventListenerEndpointDiscriminator peut être utilisé de manière interchangeable avec EventListenerEndpointDiscriminator, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

eventHub

EventListenerEndpointUnion
EventListenerFilterDiscriminator

Définit des valeurs pour EventListenerFilterDiscriminator.
KnownEventListenerFilterDiscriminator peut être utilisé de manière interchangeable avec EventListenerFilterDiscriminator, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

EventName

EventListenerFilterUnion
KeyType

Définit des valeurs pour KeyType.
KnownKeyType peut être utilisé de manière interchangeable avec KeyType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

principal
secondaire
Salt

ManagedIdentityType

Définit des valeurs pour ManagedIdentityType.
KnownManagedIdentityType peut être utilisé de manière interchangeable avec ManagedIdentityType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Aucun
SystemAssigned
UserAssigned

OperationsListNextResponse

Contient des données de réponse pour l’opération listNext.

OperationsListResponse

Contient des données de réponse pour l’opération de liste.

PrivateLinkServiceConnectionStatus

Définit des valeurs pour PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus pouvez être utilisé de manière interchangeable avec PrivateLinkServiceConnectionStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

en attente
approuvé
rejeté
déconnecté

ProvisioningState

Définit des valeurs pour ProvisioningState.
KnownProvisioningState peut être utilisé de manière interchangeable avec ProvisioningState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

inconnu
réussi
échec
annulé
en cours d’exécution
création d'
mise à jour
suppression de
déplacement de

ScaleType

Définit des valeurs pour ScaleType.
KnownScaleType peut être utilisé de manière interchangeable avec ScaleType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Aucun
manuel
automatique

ServiceKind

Définit des valeurs pour ServiceKind.
KnownServiceKind peut être utilisé de manière interchangeable avec ServiceKind, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

webPubSub
SocketIO

SharedPrivateLinkResourceStatus

Définit des valeurs pour SharedPrivateLinkResourceStatus.
KnownSharedPrivateLinkResourceStatus pouvez être utilisé de manière interchangeable avec SharedPrivateLinkResourceStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

en attente
approuvé
rejeté
déconnecté
délai d’expiration

UpstreamAuthType

Définit des valeurs pour UpstreamAuthType.
KnownUpstreamAuthType peut être utilisé de manière interchangeable avec UpstreamAuthType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Aucun
managedIdentity

UsagesListNextResponse

Contient des données de réponse pour l’opération listNext.

UsagesListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubCheckNameAvailabilityResponse

Contient des données de réponse pour l’opération checkNameAvailability.

WebPubSubCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubCustomCertificatesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubCustomCertificatesGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubCustomCertificatesListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubCustomCertificatesListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubCustomDomainsCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubCustomDomainsGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubCustomDomainsListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubCustomDomainsListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubHubsCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubHubsGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubHubsListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubHubsListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubListByResourceGroupNextResponse

Contient des données de réponse pour l’opération listByResourceGroupNext.

WebPubSubListByResourceGroupResponse

Contient des données de réponse pour l’opération listByResourceGroup.

WebPubSubListBySubscriptionNextResponse

Contient des données de réponse pour l’opération listBySubscriptionNext.

WebPubSubListBySubscriptionResponse

Contient des données de réponse pour l’opération listBySubscription.

WebPubSubListKeysResponse

Contient des données de réponse pour l’opération listKeys.

WebPubSubListReplicaSkusResponse

Contient des données de réponse pour l’opération listReplicaSkus.

WebPubSubListSkusResponse

Contient des données de réponse pour l’opération listSkus.

WebPubSubPrivateEndpointConnectionsGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubPrivateEndpointConnectionsListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubPrivateEndpointConnectionsListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubPrivateEndpointConnectionsUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

WebPubSubPrivateLinkResourcesListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubPrivateLinkResourcesListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubRegenerateKeyResponse

Contient des données de réponse pour l’opération régénéréKey.

WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubReplicaSharedPrivateLinkResourcesGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubReplicaSharedPrivateLinkResourcesListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubReplicasCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubReplicasGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubReplicasListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubReplicasListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubReplicasRestartResponse

Contient des données de réponse pour l’opération de redémarrage.

WebPubSubReplicasUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

WebPubSubRequestType

Définit des valeurs pour WebPubSubRequestType.
KnownWebPubSubRequestType pouvez être utilisé de manière interchangeable avec WebPubSubRequestType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

clientConnection
ServerConnection
RESTAPI
trace

WebPubSubRestartResponse

Contient des données de réponse pour l’opération de redémarrage.

WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

WebPubSubSharedPrivateLinkResourcesGetResponse

Contient des données de réponse pour l’opération d’obtention.

WebPubSubSharedPrivateLinkResourcesListNextResponse

Contient des données de réponse pour l’opération listNext.

WebPubSubSharedPrivateLinkResourcesListResponse

Contient des données de réponse pour l’opération de liste.

WebPubSubSkuTier

Définit des valeurs pour WebPubSubSkuTier.
KnownWebPubSubSkuTier pouvez être utilisé de manière interchangeable avec WebPubSubSkuTier, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

gratuit
de base
standard
Premium

WebPubSubUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

Énumérations

KnownACLAction

Valeurs connues de ACLAction que le service accepte.

KnownCreatedByType

Valeurs connues de CreatedByType que le service accepte.

KnownEventListenerEndpointDiscriminator

Valeurs connues de EventListenerEndpointDiscriminator que le service accepte.

KnownEventListenerFilterDiscriminator

Valeurs connues de EventListenerFilterDiscriminator que le service accepte.

KnownKeyType

Valeurs connues de KeyType que le service accepte.

KnownManagedIdentityType

Valeurs connues de ManagedIdentityType que le service accepte.

KnownPrivateLinkServiceConnectionStatus

Valeurs connues de PrivateLinkServiceConnectionStatus que le service accepte.

KnownProvisioningState

Valeurs connues de ProvisioningState que le service accepte.

KnownScaleType

Valeurs connues de ScaleType que le service accepte.

KnownServiceKind

Valeurs connues de ServiceKind que le service accepte.

KnownSharedPrivateLinkResourceStatus

Valeurs connues de SharedPrivateLinkResourceStatus que le service accepte.

KnownUpstreamAuthType

Valeurs connues de UpstreamAuthType que le service accepte.

KnownWebPubSubRequestType

Valeurs connues de WebPubSubRequestType que le service accepte.

KnownWebPubSubSkuTier

Valeurs connues de WebPubSubSkuTier que le service accepte.

Functions

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet qui accède à value sur IteratorResult à partir d’un itérateur byPage.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() pendant les appels futurs.