@azure/arm-webpubsub package

Classes

WebPubSubManagementClient

Interfaces

CustomCertificate	Um certificado personalizado.
CustomCertificateList	Lista de certificados personalizados.
CustomDomain	Um domínio personalizado
CustomDomainList	Lista de domínios personalizados
Dimension	Especificações da Dimensão das métricas.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
EventHandler	Propriedades do manipulador de eventos.
EventHubEndpoint	Um ponto de extremidade do Hub de Eventos. A identidade gerenciada do serviço Web PubSub deve estar habilitada e a identidade deve ter a função "Remetente de Dados dos Hubs de Eventos do Azure" para acessar o Hub de Eventos.
EventListener	Uma configuração define quais tipos de eventos devem ser enviados para qual ponto de extremidade.
EventListenerEndpoint	Um ponto de extremidade que especifica para onde o Web PubSub deve enviar eventos.
EventListenerFilter	Uma classe base para filtro de evento que determina se um evento deve ser enviado para um ouvinte de eventos.
EventNameFilter	Filtre eventos pelo nome.
IPRule	Uma regra de IP
LiveTraceCategory	Configuração de categoria de rastreamento ao vivo de um recurso Microsoft.SignalRService.
LiveTraceConfiguration	Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService.
LogSpecification	Especificações dos logs do Monitoramento do Azure.
ManagedIdentity	Uma classe representa identidades gerenciadas usadas para solicitação e resposta
ManagedIdentitySettings	Configurações de identidade gerenciada para upstream.
MetricSpecification	Especificações das métricas do Monitoramento do Azure.
NameAvailability	Resultado da solicitação para verificar a disponibilidade do nome. Ele contém um sinalizador e um possível motivo de falha.
NameAvailabilityParameters	Data POST-ed para a ação nameAvailability
NetworkACL	ACL de rede
Operation	Operação de API REST com suporte pelo provedor de recursos.
OperationDisplay	O objeto que descreve uma operação.
OperationList	Resultado da solicitação para listar as operações da API REST. Ele contém uma lista de operações.
OperationProperties	Propriedades de Operação Extra.
Operations	Interface que representa uma operação.
OperationsListNextOptionalParams	Parâmetros opcionais.
OperationsListOptionalParams	Parâmetros opcionais.
PrivateEndpoint	Ponto de extremidade privado
PrivateEndpointACL	ACL para um ponto de extremidade privado
PrivateEndpointConnection	Uma conexão de ponto de extremidade privado com um recurso do azure
PrivateEndpointConnectionList	Uma lista de conexões de ponto de extremidade privado
PrivateLinkResource	Recurso de link privado
PrivateLinkResourceList	Contém uma lista de PrivateLinkResource e um possível link para consultar mais resultados
PrivateLinkServiceConnectionState	Estado de conexão da conexão de ponto de extremidade privado
ProxyResource	A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local
RegenerateKeyParameters	Parâmetros descrevem a solicitação para regenerar chaves de acesso
Replica	Uma classe representa um recurso de réplica.
ReplicaList
Resource	Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager
ResourceLogCategory	Configuração da categoria de log de recursos de um recurso Microsoft.SignalRService.
ResourceLogConfiguration	Configuração de log de recursos de um recurso Microsoft.SignalRService.
ResourceReference	Referência a um recurso.
ResourceSku	As informações de cobrança do recurso.
ServiceSpecification	Um objeto que descreve uma especificação.
ShareablePrivateLinkResourceProperties	Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado
ShareablePrivateLinkResourceType	Descreve um tipo de recurso que foi integrado ao serviço de link privado
SharedPrivateLinkResource	Descreve um recurso de link privado compartilhado
SharedPrivateLinkResourceList	Uma lista de recursos de link privado compartilhados
SignalRServiceUsage	Objeto que descreve um uso específico dos recursos.
SignalRServiceUsageList	Objeto que inclui uma matriz de usos de recursos e um possível link para o próximo conjunto.
SignalRServiceUsageName	Objeto De cadeia de caracteres localizável que contém o nome e um valor localizado.
Sku	Descreve um sku disponível."
SkuCapacity	Descreve informações de dimensionamento de um sku.
SkuList	A resposta da operação de skus de lista
SystemData	Metadados relativos à criação e última modificação do recurso.
TrackedResource	A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'
UpstreamAuthSettings	Configurações de autenticação upstream. Se não estiver definido, nenhuma autenticação será usada para mensagens upstream.
Usages	Interface que representa um Usos.
UsagesListNextOptionalParams	Parâmetros opcionais.
UsagesListOptionalParams	Parâmetros opcionais.
UserAssignedIdentityProperty	Propriedades da identidade atribuída pelo usuário.
WebPubSub	Interface que representa um WebPubSub.
WebPubSubCheckNameAvailabilityOptionalParams	Parâmetros opcionais.
WebPubSubCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubCustomCertificates	Interface que representa um WebPubSubCustomCertificates.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubCustomCertificatesDeleteOptionalParams	Parâmetros opcionais.
WebPubSubCustomCertificatesGetOptionalParams	Parâmetros opcionais.
WebPubSubCustomCertificatesListNextOptionalParams	Parâmetros opcionais.
WebPubSubCustomCertificatesListOptionalParams	Parâmetros opcionais.
WebPubSubCustomDomains	Interface que representa um WebPubSubCustomDomains.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubCustomDomainsDeleteOptionalParams	Parâmetros opcionais.
WebPubSubCustomDomainsGetOptionalParams	Parâmetros opcionais.
WebPubSubCustomDomainsListNextOptionalParams	Parâmetros opcionais.
WebPubSubCustomDomainsListOptionalParams	Parâmetros opcionais.
WebPubSubDeleteOptionalParams	Parâmetros opcionais.
WebPubSubGetOptionalParams	Parâmetros opcionais.
WebPubSubHub	Uma configuração de hub
WebPubSubHubList	Lista de configurações do hub
WebPubSubHubProperties	Propriedades de um hub.
WebPubSubHubs	Interface que representa um WebPubSubHubs.
WebPubSubHubsCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubHubsDeleteOptionalParams	Parâmetros opcionais.
WebPubSubHubsGetOptionalParams	Parâmetros opcionais.
WebPubSubHubsListNextOptionalParams	Parâmetros opcionais.
WebPubSubHubsListOptionalParams	Parâmetros opcionais.
WebPubSubKeys	Uma classe representa as chaves de acesso do recurso.
WebPubSubListByResourceGroupNextOptionalParams	Parâmetros opcionais.
WebPubSubListByResourceGroupOptionalParams	Parâmetros opcionais.
WebPubSubListBySubscriptionNextOptionalParams	Parâmetros opcionais.
WebPubSubListBySubscriptionOptionalParams	Parâmetros opcionais.
WebPubSubListKeysOptionalParams	Parâmetros opcionais.
WebPubSubListReplicaSkusOptionalParams	Parâmetros opcionais.
WebPubSubListSkusOptionalParams	Parâmetros opcionais.
WebPubSubManagementClientOptionalParams	Parâmetros opcionais.
WebPubSubNetworkACLs	ACLs de rede para o recurso
WebPubSubPrivateEndpointConnections	Interface que representa um WebPubSubPrivateEndpointConnections.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams	Parâmetros opcionais.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Parâmetros opcionais.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Parâmetros opcionais.
WebPubSubPrivateLinkResources	Interface que representa um WebPubSubPrivateLinkResources.
WebPubSubPrivateLinkResourcesListNextOptionalParams	Parâmetros opcionais.
WebPubSubPrivateLinkResourcesListOptionalParams	Parâmetros opcionais.
WebPubSubRegenerateKeyHeaders	Define cabeçalhos para WebPubSub_regenerateKey operação.
WebPubSubRegenerateKeyOptionalParams	Parâmetros opcionais.
WebPubSubReplicaSharedPrivateLinkResources	Interface que representa um WebPubSubReplicaSharedPrivateLinkResources.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams	Parâmetros opcionais.
WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams	Parâmetros opcionais.
WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams	Parâmetros opcionais.
WebPubSubReplicas	Interface que representa um WebPubSubReplicas.
WebPubSubReplicasCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubReplicasDeleteOptionalParams	Parâmetros opcionais.
WebPubSubReplicasGetOptionalParams	Parâmetros opcionais.
WebPubSubReplicasListNextOptionalParams	Parâmetros opcionais.
WebPubSubReplicasListOptionalParams	Parâmetros opcionais.
WebPubSubReplicasRestartHeaders	Define cabeçalhos para WebPubSubReplicas_restart operação.
WebPubSubReplicasRestartOptionalParams	Parâmetros opcionais.
WebPubSubReplicasUpdateHeaders	Define cabeçalhos para WebPubSubReplicas_update operação.
WebPubSubReplicasUpdateOptionalParams	Parâmetros opcionais.
WebPubSubResource	Uma classe representa um recurso.
WebPubSubResourceList	Objeto que inclui uma matriz de recursos e um possível link para o próximo conjunto.
WebPubSubRestartHeaders	Define cabeçalhos para WebPubSub_restart operação.
WebPubSubRestartOptionalParams	Parâmetros opcionais.
WebPubSubSharedPrivateLinkResources	Interface que representa um WebPubSubSharedPrivateLinkResources.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Parâmetros opcionais.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Parâmetros opcionais.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Parâmetros opcionais.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams	Parâmetros opcionais.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Parâmetros opcionais.
WebPubSubSocketIOSettings	Configurações do SocketIO para o recurso
WebPubSubTlsSettings	Configurações de TLS para o recurso
WebPubSubUpdateHeaders	Define cabeçalhos para WebPubSub_update operação.
WebPubSubUpdateOptionalParams	Parâmetros opcionais.

Aliases de tipo

ACLAction	Define valores para ACLAction. KnownACLAction pode ser usado de forma intercambiável com ACLAction, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Permitir negar
CreatedByType	Define valores para CreatedByType. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço de usuário do application ManagedIdentity key
EventListenerEndpointDiscriminator	Define valores para EventListenerEndpointDiscriminator. KnownEventListenerEndpointDiscriminator pode ser usado de forma intercambiável com EventListenerEndpointDiscriminator, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço do EventHub
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Define valores para EventListenerFilterDiscriminator. KnownEventListenerFilterDiscriminator podem ser usados de forma intercambiável com EventListenerFilterDiscriminator, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço EventName
EventListenerFilterUnion
KeyType	Define valores para KeyType. KnownKeyType pode ser usado de forma intercambiável com KeyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Primário do Secundário de Sal
ManagedIdentityType	Define valores para ManagedIdentityType. KnownManagedIdentityType pode ser usado de forma intercambiável com ManagedIdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhum SystemAssigned UserAssigned
OperationsListNextResponse	Contém dados de resposta para a operação listNext.
OperationsListResponse	Contém dados de resposta para a operação de lista.
PrivateLinkServiceConnectionStatus	Define valores para PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus pode ser usado de forma intercambiável com PrivateLinkServiceConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço pendente aprovado rejeitado Desconectado
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Desconhecido êxito falha na Cancelada executando criando atualizando excluindo movendo
ScaleType	Define valores para ScaleType. KnownScaleType pode ser usado de forma intercambiável com ScaleType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhum Manual do Automático
ServiceKind	Define valores para ServiceKind. KnownServiceKind pode ser usado de forma intercambiável com o ServiceKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço WebPubSub do Soquete
SharedPrivateLinkResourceStatus	Define valores para SharedPrivateLinkResourceStatus. KnownSharedPrivateLinkResourceStatus pode ser usado de forma intercambiável com SharedPrivateLinkResourceStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço pendente aprovado rejeitado Desconectado tempo limite
UpstreamAuthType	Define valores para UpstreamAuthType. KnownUpstreamAuthType pode ser usado de forma intercambiável com UpstreamAuthType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Nenhum ManagedIdentity
UsagesListNextResponse	Contém dados de resposta para a operação listNext.
UsagesListResponse	Contém dados de resposta para a operação de lista.
WebPubSubCheckNameAvailabilityResponse	Contém dados de resposta para a operação checkNameAvailability.
WebPubSubCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubCustomCertificatesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubCustomCertificatesGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubCustomCertificatesListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubCustomCertificatesListResponse	Contém dados de resposta para a operação de lista.
WebPubSubCustomDomainsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubCustomDomainsGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubCustomDomainsListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubCustomDomainsListResponse	Contém dados de resposta para a operação de lista.
WebPubSubGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubHubsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubHubsGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubHubsListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubHubsListResponse	Contém dados de resposta para a operação de lista.
WebPubSubListByResourceGroupNextResponse	Contém dados de resposta para a operação listByResourceGroupNext.
WebPubSubListByResourceGroupResponse	Contém dados de resposta para a operação listByResourceGroup.
WebPubSubListBySubscriptionNextResponse	Contém dados de resposta para a operação listBySubscriptionNext.
WebPubSubListBySubscriptionResponse	Contém dados de resposta para a operação listBySubscription.
WebPubSubListKeysResponse	Contém dados de resposta para a operação listKeys.
WebPubSubListReplicaSkusResponse	Contém dados de resposta para a operação listReplicaSkus.
WebPubSubListSkusResponse	Contém dados de resposta para a operação listSkus.
WebPubSubPrivateEndpointConnectionsGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubPrivateEndpointConnectionsListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubPrivateEndpointConnectionsListResponse	Contém dados de resposta para a operação de lista.
WebPubSubPrivateEndpointConnectionsUpdateResponse	Contém dados de resposta para a operação de atualização.
WebPubSubPrivateLinkResourcesListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubPrivateLinkResourcesListResponse	Contém dados de resposta para a operação de lista.
WebPubSubRegenerateKeyResponse	Contém dados de resposta para a operação regenerateKey.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubReplicaSharedPrivateLinkResourcesGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubReplicaSharedPrivateLinkResourcesListResponse	Contém dados de resposta para a operação de lista.
WebPubSubReplicasCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubReplicasGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubReplicasListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubReplicasListResponse	Contém dados de resposta para a operação de lista.
WebPubSubReplicasRestartResponse	Contém dados de resposta para a operação de reinicialização.
WebPubSubReplicasUpdateResponse	Contém dados de resposta para a operação de atualização.
WebPubSubRequestType	Define valores para WebPubSubRequestType. KnownWebPubSubRequestType pode ser usado de forma intercambiável com WebPubSubRequestType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço ClientConnection ServerConnection DO RESTAPI de rastreamento de
WebPubSubRestartResponse	Contém dados de resposta para a operação de reinicialização.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubSharedPrivateLinkResourcesGetResponse	Contém dados de resposta para a operação de obtenção.
WebPubSubSharedPrivateLinkResourcesListNextResponse	Contém dados de resposta para a operação listNext.
WebPubSubSharedPrivateLinkResourcesListResponse	Contém dados de resposta para a operação de lista.
WebPubSubSkuTier	Define valores para WebPubSubSkuTier. KnownWebPubSubSkuTier pode ser usado de forma intercambiável com WebPubSubSkuTier, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço gratuita Básico Standard Premium
WebPubSubUpdateResponse	Contém dados de resposta para a operação de atualização.

Enumerações

KnownACLAction	Valores conhecidos de ACLAction que o serviço aceita.
KnownCreatedByType	Valores conhecidos de CreatedByType que o serviço aceita.
KnownEventListenerEndpointDiscriminator	Valores conhecidos de EventListenerEndpointDiscriminator que o serviço aceita.
KnownEventListenerFilterDiscriminator	Valores conhecidos de EventListenerFilterDiscriminator que o serviço aceita.
KnownKeyType	Valores conhecidos de KeyType que o serviço aceita.
KnownManagedIdentityType	Valores conhecidos de ManagedIdentityType que o serviço aceita.
KnownPrivateLinkServiceConnectionStatus	Valores conhecidos de PrivateLinkServiceConnectionStatus que o serviço aceita.
KnownProvisioningState	Valores conhecidos de ProvisioningState que o serviço aceita.
KnownScaleType	Valores conhecidos de ScaleType que o serviço aceita.
KnownServiceKind	Valores conhecidos de ServiceKind que o serviço aceita.
KnownSharedPrivateLinkResourceStatus	Valores conhecidos de SharedPrivateLinkResourceStatus que o serviço aceita.
KnownUpstreamAuthType	Valores conhecidos de UpstreamAuthType que o serviço aceita.
KnownWebPubSubRequestType	Valores conhecidos de WebPubSubRequestType que o serviço aceita.
KnownWebPubSubSkuTier	Valores conhecidos de WebPubSubSkuTier que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador de byPage.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.