@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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 ser 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 especificando para onde o Web PubSub deve enviar eventos.
EventListenerFilter	Uma classe base para filtro de eventos 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 em tempo real de um recurso Microsoft.SignalRService.
LiveTraceConfiguration	Configuração de rastreamento em tempo real de um recurso Microsoft.SignalRService.
LogSpecification	Especificações dos logs para monitoramento do Azure.
ManagedIdentity	Uma classe representa identidades gerenciadas usadas para solicitação e resposta
ManagedIdentitySettings	Configurações de identidade gerenciadas para upstream.
MetricSpecification	Especificações das métricas para o monitoramento do Azure.
NameAvailability	Resultado do pedido de verificação de disponibilidade de nomes. Ele contém uma bandeira e possível motivo de falha.
NameAvailabilityParameters	Dados POST-ed para a ação nameAvailability
NetworkACL	ACL de rede
Operation	Operação da API REST suportada pelo provedor de recursos.
OperationDisplay	O objeto que descreve uma operação.
OperationList	Resultado da solicitação para listar operações da API REST. 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 final privado
PrivateEndpointACL	ACL para um endpoint 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 privadas
PrivateLinkResource	Recurso de link privado
PrivateLinkResourceList	Contém uma lista de PrivateLinkResource e um possível link para consultar mais resultados
PrivateLinkServiceConnectionState	Estado da conexão da conexão de ponto de extremidade privado
ProxyResource	A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local
RegenerateKeyParameters	Parâmetros descreve 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 de categoria de log de recursos de um recurso Microsoft.SignalRService.
ResourceLogConfiguration	Configuração do log de recursos de um recurso Microsoft.SignalRService.
ResourceReference	Referência a um recurso.
ResourceSku	As informações de faturamento 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 compartilhado
SignalRServiceUsage	Objeto que descreve um uso específico dos recursos.
SignalRServiceUsageList	Objeto que inclui uma matriz dos usos de recursos e um possível link para o próximo conjunto.
SignalRServiceUsageName	Objeto String localizável contendo o nome e um valor localizado.
Sku	Descreve uma sku disponível."
SkuCapacity	Descreve as informações de dimensionamento de uma sku.
SkuList	A resposta da operação de lista skus
SystemData	Metadados referentes à criação e última modificação do recurso.
TrackedResource	A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local'
UpstreamAuthSettings	Configurações de autenticação upstream. Se não estiver definida, 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 de 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 de 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 o ACLAction, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Permitir Negar
CreatedByType	Define valores para CreatedByType. KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço do Utilizador Application ManagedIdentity Key
EventListenerEndpointDiscriminator	Define valores para EventListenerEndpointDiscriminator. KnownEventListenerEndpointDiscriminator pode ser usado de forma intercambiável com EventListenerEndpointDiscriminator, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço do EventHub
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Define valores para EventListenerFilterDiscriminator. KnownEventListenerFilterDiscriminator pode ser usado de forma intercambiável com EventListenerFilterDiscriminator, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço EventName
EventListenerFilterUnion
KeyType	Define valores para KeyType. KnownKeyType pode ser usado de forma intercambiável com KeyType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Primária Secundária de Sal
ManagedIdentityType	Define valores para ManagedIdentityType. KnownManagedIdentityType pode ser usado de forma intercambiável com ManagedIdentityType, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo 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, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço pendente Aprovado Rejeitado Desconectado
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Desconhecido Sucedeu Falhou Cancelado Executando Criação de Atualização Excluindo Moving
ScaleType	Define valores para ScaleType. KnownScaleType pode ser usado de forma intercambiável com ScaleType, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Nenhum Manual automática
ServiceKind	Define valores para ServiceKind. KnownServiceKind pode ser usado de forma intercambiável com ServiceKind, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço WebPubSub SocketIO
SharedPrivateLinkResourceStatus	Define valores para SharedPrivateLinkResourceStatus. KnownSharedPrivateLinkResourceStatus pode ser usado de forma intercambiável com SharedPrivateLinkResourceStatus, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço pendente Aprovado Rejeitado Desconectado Tempo limite
UpstreamAuthType	Define valores para UpstreamAuthType. KnownUpstreamAuthType pode ser usado de forma intercambiável com UpstreamAuthType, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo 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 get.
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 get.
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 get.
WebPubSubHubsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
WebPubSubHubsGetResponse	Contém dados de resposta para a operação get.
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 get.
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 get.
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 get.
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, esse enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço ClientConnection ServerConnection RESTAPI Trace
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 get.
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, este enum contém os valores conhecidos que o serviço suporta. Valores conhecidos suportados pelo serviço Grátis Básico Standard Premium
WebPubSubUpdateResponse	Contém dados de resposta para a operação de atualização.

Enumerações

KnownACLAction	Os valores conhecidos de ACLAction que o serviço aceita.
KnownCreatedByType	Os valores conhecidos de CreatedByType que o serviço aceita.
KnownEventListenerEndpointDiscriminator	Os valores conhecidos de EventListenerEndpointDiscriminator que o serviço aceita.
KnownEventListenerFilterDiscriminator	Os valores conhecidos de EventListenerFilterDiscriminator que o serviço aceita.
KnownKeyType	Valores conhecidos de KeyType que o serviço aceita.
KnownManagedIdentityType	Os valores conhecidos de ManagedIdentityType que o serviço aceita.
KnownPrivateLinkServiceConnectionStatus	Os valores conhecidos de PrivateLinkServiceConnectionStatus que o serviço aceita.
KnownProvisioningState	Os valores conhecidos de ProvisioningState que o serviço aceita.
KnownScaleType	Os valores conhecidos de ScaleType que o serviço aceita.
KnownServiceKind	Os valores conhecidos de ServiceKind que o serviço aceita.
KnownSharedPrivateLinkResourceStatus	Os valores conhecidos de SharedPrivateLinkResourceStatus que o serviço aceita.
KnownUpstreamAuthType	Os valores conhecidos de UpstreamAuthType que o serviço aceita.
KnownWebPubSubRequestType	Os valores conhecidos de WebPubSubRequestType que o serviço aceita.
KnownWebPubSubSkuTier	Os 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 de 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 byPage.

Devoluções

string | undefined

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