@azure/arm-webpubsub package
Clases
| WebPubSubManagementClient |
Interfaces
| CustomCertificate |
Un certificado personalizado. |
| CustomCertificateList |
Lista de certificados personalizados. |
| CustomDomain |
Un dominio personalizado |
| CustomDomainList |
Lista de dominios personalizados |
| Dimension |
Especificaciones de la dimensión de las métricas. |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorDetail |
Detalle del error. |
| ErrorResponse |
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData). |
| EventHandler |
Propiedades del controlador de eventos. |
| EventHubEndpoint |
Un punto de conexión del centro de eventos. La identidad administrada del servicio Web PubSub debe estar habilitada y la identidad debe tener el rol "remitente de datos de Azure Event Hubs" para acceder al centro de eventos. |
| EventListener |
Una configuración define qué tipos de eventos se deben enviar al punto de conexión. |
| EventListenerEndpoint |
Un punto de conexión que especifica dónde Web PubSub debe enviar eventos. |
| EventListenerFilter |
Clase base para el filtro de eventos que determina si se debe enviar un evento a un agente de escucha de eventos. |
| EventNameFilter |
Filtre los eventos por su nombre. |
| IPRule |
Una regla de IP |
| LiveTraceCategory |
Configuración de categoría de seguimiento activo de un recurso Microsoft.SignalRService. |
| LiveTraceConfiguration |
Configuración de seguimiento activo de un recurso Microsoft.SignalRService. |
| LogSpecification |
Especificaciones de los registros para la supervisión de Azure. |
| ManagedIdentity |
Una clase representa las identidades administradas usadas para la solicitud y la respuesta. |
| ManagedIdentitySettings |
Configuración de identidad administrada para ascendente. |
| MetricSpecification |
Especificaciones de las métricas para la supervisión de Azure. |
| NameAvailability |
Resultado de la solicitud para comprobar la disponibilidad del nombre. Contiene una marca y una posible razón de error. |
| NameAvailabilityParameters |
Datos POST-ed a la acción nameAvailability |
| NetworkACL |
ACL de red |
| Operation |
Operación de API REST compatible con el proveedor de recursos. |
| OperationDisplay |
Objeto que describe una operación. |
| OperationList |
Resultado de la solicitud para enumerar las operaciones de la API REST. Contiene una lista de operaciones. |
| OperationProperties |
Propiedades de operación adicional. |
| Operations |
Interfaz que representa una operación. |
| OperationsListNextOptionalParams |
Parámetros opcionales. |
| OperationsListOptionalParams |
Parámetros opcionales. |
| PrivateEndpoint |
Punto de conexión privado |
| PrivateEndpointACL |
ACL para un punto de conexión privado |
| PrivateEndpointConnection |
Una conexión de punto de conexión privado a un recurso de Azure |
| PrivateEndpointConnectionList |
Lista de conexiones de punto de conexión privado |
| PrivateLinkResource |
Recurso private link |
| PrivateLinkResourceList |
Contiene una lista de PrivateLinkResource y un posible vínculo para consultar más resultados. |
| PrivateLinkServiceConnectionState |
Estado de conexión de la conexión del punto de conexión privado |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| RegenerateKeyParameters |
Los parámetros describen la solicitud para volver a generar las claves de acceso. |
| Replica |
Una clase representa un recurso de réplica. |
| ReplicaList | |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| ResourceLogCategory |
Configuración de categoría del registro de recursos de un recurso Microsoft.SignalRService. |
| ResourceLogConfiguration |
Configuración del registro de recursos de un recurso Microsoft.SignalRService. |
| ResourceReference |
Referencia a un recurso. |
| ResourceSku |
Información de facturación del recurso. |
| ServiceSpecification |
Objeto que describe una especificación. |
| ShareablePrivateLinkResourceProperties |
Describe las propiedades de un tipo de recurso que se ha incorporado al servicio private link. |
| ShareablePrivateLinkResourceType |
Describe un tipo de recurso que se ha incorporado al servicio private link. |
| SharedPrivateLinkResource |
Describe un recurso de Private Link compartido |
| SharedPrivateLinkResourceList |
Lista de recursos de vínculo privado compartidos |
| SignalRServiceUsage |
Objeto que describe un uso específico de los recursos. |
| SignalRServiceUsageList |
Objeto que incluye una matriz de los usos de recursos y un vínculo posible para el siguiente conjunto. |
| SignalRServiceUsageName |
Objeto String localizable que contiene el nombre y un valor localizado. |
| Sku |
Describe una SKU disponible". |
| SkuCapacity |
Describe la información de escalado de una SKU. |
| SkuList |
Respuesta de la operación de sku de lista |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| UpstreamAuthSettings |
Configuración de autenticación ascendente. Si no se establece, no se usa ninguna autenticación para los mensajes ascendentes. |
| Usages |
Interfaz que representa un uso. |
| UsagesListNextOptionalParams |
Parámetros opcionales. |
| UsagesListOptionalParams |
Parámetros opcionales. |
| UserAssignedIdentityProperty |
Propiedades de la identidad asignada por el usuario. |
| WebPubSub |
Interfaz que representa un WebPubSub. |
| WebPubSubCheckNameAvailabilityOptionalParams |
Parámetros opcionales. |
| WebPubSubCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomCertificates |
Interfaz que representa un WebPubSubCustomCertificates. |
| WebPubSubCustomCertificatesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomCertificatesDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomCertificatesGetOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomCertificatesListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomCertificatesListOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomDomains |
Interfaz que representa un WebPubSubCustomDomains. |
| WebPubSubCustomDomainsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomDomainsDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomDomainsGetOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomDomainsListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubCustomDomainsListOptionalParams |
Parámetros opcionales. |
| WebPubSubDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubGetOptionalParams |
Parámetros opcionales. |
| WebPubSubHub |
Una configuración de concentrador |
| WebPubSubHubList |
Lista de configuración del concentrador |
| WebPubSubHubProperties |
Propiedades de un centro de conectividad. |
| WebPubSubHubs |
Interfaz que representa un WebPubSubHubs. |
| WebPubSubHubsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubHubsDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubHubsGetOptionalParams |
Parámetros opcionales. |
| WebPubSubHubsListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubHubsListOptionalParams |
Parámetros opcionales. |
| WebPubSubKeys |
Una clase representa las claves de acceso del recurso. |
| WebPubSubListByResourceGroupNextOptionalParams |
Parámetros opcionales. |
| WebPubSubListByResourceGroupOptionalParams |
Parámetros opcionales. |
| WebPubSubListBySubscriptionNextOptionalParams |
Parámetros opcionales. |
| WebPubSubListBySubscriptionOptionalParams |
Parámetros opcionales. |
| WebPubSubListKeysOptionalParams |
Parámetros opcionales. |
| WebPubSubListReplicaSkusOptionalParams |
Parámetros opcionales. |
| WebPubSubListSkusOptionalParams |
Parámetros opcionales. |
| WebPubSubManagementClientOptionalParams |
Parámetros opcionales. |
| WebPubSubNetworkACLs |
ACL de red para el recurso |
| WebPubSubPrivateEndpointConnections |
Interfaz que representa un WebPubSubPrivateEndpointConnections. |
| WebPubSubPrivateEndpointConnectionsDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateEndpointConnectionsGetOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateEndpointConnectionsListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateEndpointConnectionsListOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateEndpointConnectionsUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateLinkResources |
Interfaz que representa un objeto WebPubSubPrivateLinkResources. |
| WebPubSubPrivateLinkResourcesListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubPrivateLinkResourcesListOptionalParams |
Parámetros opcionales. |
| WebPubSubRegenerateKeyHeaders |
Define encabezados para WebPubSub_regenerateKey operación. |
| WebPubSubRegenerateKeyOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicaSharedPrivateLinkResources |
Interfaz que representa un objeto WebPubSubReplicaSharedPrivateLinkResources. |
| WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicas |
Interfaz que representa una webPubSubReplicas. |
| WebPubSubReplicasCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasGetOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasListOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasRestartHeaders |
Define encabezados para WebPubSubReplicas_restart operación. |
| WebPubSubReplicasRestartOptionalParams |
Parámetros opcionales. |
| WebPubSubReplicasUpdateHeaders |
Define encabezados para WebPubSubReplicas_update operación. |
| WebPubSubReplicasUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubResource |
Una clase representa un recurso. |
| WebPubSubResourceList |
Objeto que incluye una matriz de recursos y un posible vínculo para el siguiente conjunto. |
| WebPubSubRestartHeaders |
Define encabezados para WebPubSub_restart operación. |
| WebPubSubRestartOptionalParams |
Parámetros opcionales. |
| WebPubSubSharedPrivateLinkResources |
Interfaz que representa un WebPubSubSharedPrivateLinkResources. |
| WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams |
Parámetros opcionales. |
| WebPubSubSharedPrivateLinkResourcesGetOptionalParams |
Parámetros opcionales. |
| WebPubSubSharedPrivateLinkResourcesListNextOptionalParams |
Parámetros opcionales. |
| WebPubSubSharedPrivateLinkResourcesListOptionalParams |
Parámetros opcionales. |
| WebPubSubSocketIOSettings |
Configuración de SocketIO para el recurso |
| WebPubSubTlsSettings |
Configuración de TLS para el recurso |
| WebPubSubUpdateHeaders |
Define encabezados para WebPubSub_update operación. |
| WebPubSubUpdateOptionalParams |
Parámetros opcionales. |
Alias de tipos
| ACLAction |
Define los valores de ACLAction. Valores conocidos admitidos por el servicio
Permitir |
| CreatedByType |
Define valores para CreatedByType. Valores conocidos admitidos por el servicio de usuario de |
| EventListenerEndpointDiscriminator |
Define valores para EventListenerEndpointDiscriminator. Valores conocidos admitidos por el serviciode EventHub |
| EventListenerEndpointUnion | |
| EventListenerFilterDiscriminator |
Define valores para EventListenerFilterDiscriminator. Valores conocidos admitidos por el servicioEventName |
| EventListenerFilterUnion | |
| KeyType |
Define valores para KeyType. Valores conocidos admitidos por el servicio
principal |
| ManagedIdentityType |
Define valores para ManagedIdentityType. Valores conocidos admitidos por el servicio
Ninguno |
| OperationsListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| OperationsListResponse |
Contiene datos de respuesta para la operación de lista. |
| PrivateLinkServiceConnectionStatus |
Define valores para PrivateLinkServiceConnectionStatus. Valores conocidos admitidos por el servicio
pendiente |
| ProvisioningState |
Define valores para ProvisioningState. Valores conocidos admitidos por el servicio
desconocido |
| ScaleType |
Define valores para ScaleType. Valores conocidos admitidos por el servicio
Ninguno |
| ServiceKind |
Define los valores de ServiceKind. Valores conocidos admitidos por el servicio |
| SharedPrivateLinkResourceStatus |
Define valores para SharedPrivateLinkResourceStatus. Valores conocidos admitidos por el servicio
pendiente |
| UpstreamAuthType |
Define valores para UpstreamAuthType. Valores conocidos admitidos por el servicio
Ninguno |
| UsagesListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| UsagesListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubCheckNameAvailabilityResponse |
Contiene datos de respuesta para la operación checkNameAvailability. |
| WebPubSubCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubCustomCertificatesCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubCustomCertificatesGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubCustomCertificatesListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubCustomCertificatesListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubCustomDomainsCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubCustomDomainsGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubCustomDomainsListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubCustomDomainsListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubHubsCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubHubsGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubHubsListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubHubsListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubListByResourceGroupNextResponse |
Contiene datos de respuesta para la operación listByResourceGroupNext. |
| WebPubSubListByResourceGroupResponse |
Contiene datos de respuesta para la operación listByResourceGroup. |
| WebPubSubListBySubscriptionNextResponse |
Contiene datos de respuesta para la operación listBySubscriptionNext. |
| WebPubSubListBySubscriptionResponse |
Contiene datos de respuesta para la operación listBySubscription. |
| WebPubSubListKeysResponse |
Contiene datos de respuesta para la operación listKeys. |
| WebPubSubListReplicaSkusResponse |
Contiene datos de respuesta para la operación listReplicaSkus. |
| WebPubSubListSkusResponse |
Contiene datos de respuesta para la operación listSkus. |
| WebPubSubPrivateEndpointConnectionsGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubPrivateEndpointConnectionsListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubPrivateEndpointConnectionsListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubPrivateEndpointConnectionsUpdateResponse |
Contiene datos de respuesta para la operación de actualización. |
| WebPubSubPrivateLinkResourcesListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubPrivateLinkResourcesListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubRegenerateKeyResponse |
Contiene datos de respuesta para la operación regenerateKey. |
| WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubReplicaSharedPrivateLinkResourcesGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubReplicaSharedPrivateLinkResourcesListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubReplicasCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubReplicasGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubReplicasListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubReplicasListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubReplicasRestartResponse |
Contiene datos de respuesta para la operación de reinicio. |
| WebPubSubReplicasUpdateResponse |
Contiene datos de respuesta para la operación de actualización. |
| WebPubSubRequestType |
Define valores para WebPubSubRequestType. Valores conocidos admitidos por el servicio
ClientConnection |
| WebPubSubRestartResponse |
Contiene datos de respuesta para la operación de reinicio. |
| WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse |
Contiene datos de respuesta para la operación createOrUpdate. |
| WebPubSubSharedPrivateLinkResourcesGetResponse |
Contiene datos de respuesta para la operación get. |
| WebPubSubSharedPrivateLinkResourcesListNextResponse |
Contiene datos de respuesta para la operación listNext. |
| WebPubSubSharedPrivateLinkResourcesListResponse |
Contiene datos de respuesta para la operación de lista. |
| WebPubSubSkuTier |
Define valores para WebPubSubSkuTier. Valores conocidos admitidos por el servicio
gratis |
| WebPubSubUpdateResponse |
Contiene datos de respuesta para la operación de actualización. |
Enumeraciones
| KnownACLAction |
Valores conocidos de ACLAction que acepta el servicio. |
| KnownCreatedByType |
Los valores conocidos de CreatedByType que acepta el servicio. |
| KnownEventListenerEndpointDiscriminator |
Valores conocidos de EventListenerEndpointDiscriminator que acepta el servicio. |
| KnownEventListenerFilterDiscriminator |
Valores conocidos de EventListenerFilterDiscriminator que acepta el servicio. |
| KnownKeyType |
Los valores conocidos de KeyType que acepta el servicio. |
| KnownManagedIdentityType |
Valores conocidos de ManagedIdentityType que acepta el servicio. |
| KnownPrivateLinkServiceConnectionStatus |
Los valores conocidos de PrivateLinkServiceConnectionStatus que acepta el servicio. |
| KnownProvisioningState |
Valores conocidos de provisioningState que acepta el servicio. |
| KnownScaleType |
Los valores conocidos de ScaleType que acepta el servicio. |
| KnownServiceKind |
Valores conocidos de ServiceKind que acepta el servicio. |
| KnownSharedPrivateLinkResourceStatus |
Los valores conocidos de SharedPrivateLinkResourceStatus que acepta el servicio. |
| KnownUpstreamAuthType |
Valores conocidos de UpstreamAuthType que acepta el servicio. |
| KnownWebPubSubRequestType |
Valores conocidos de WebPubSubRequestType que acepta el servicio. |
| KnownWebPubSubSkuTier |
Valores conocidos de WebPubSubSkuTier que acepta el servicio. |
Funciones
| get |
Dada la última |
Detalles de la función
getContinuationToken(unknown)
Dada la última .value generada por el iterador de byPage, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.
function getContinuationToken(page: unknown): string | undefined
Parámetros
- page
-
unknown
Objeto desde el que se accede a value en IteratorResult desde un iterador de byPage.
Devoluciones
string | undefined
Token de continuación que se puede pasar a byPage() durante futuras llamadas.