Partilhar via


@azure/arm-signalr package

Classes

SignalRManagementClient

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.)

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 ARM. Ele terá tudo menos a localização necessária e tags

RegenerateKeyParameters

Parâmetros descreve a solicitação para regenerar chaves de acesso

Resource

As propriedades principais dos recursos ARM.

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.

ServerlessSettings

Configurações sem servidor.

ServerlessUpstreamSettings

As configurações para o Upstream quando o serviço está no modo sem servidor.

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

SignalR

Interface que representa um SignalR.

SignalRCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

SignalRCorsSettings

Configurações de compartilhamento de recursos entre origens (CORS).

SignalRCreateOrUpdateOptionalParams

Parâmetros opcionais.

SignalRCustomCertificates

Interface que representa um SignalRCustomCertificates.

SignalRCustomCertificatesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SignalRCustomCertificatesDeleteOptionalParams

Parâmetros opcionais.

SignalRCustomCertificatesGetOptionalParams

Parâmetros opcionais.

SignalRCustomCertificatesListNextOptionalParams

Parâmetros opcionais.

SignalRCustomCertificatesListOptionalParams

Parâmetros opcionais.

SignalRCustomDomains

Interface que representa um SignalRCustomDomains.

SignalRCustomDomainsCreateOrUpdateOptionalParams

Parâmetros opcionais.

SignalRCustomDomainsDeleteOptionalParams

Parâmetros opcionais.

SignalRCustomDomainsGetOptionalParams

Parâmetros opcionais.

SignalRCustomDomainsListNextOptionalParams

Parâmetros opcionais.

SignalRCustomDomainsListOptionalParams

Parâmetros opcionais.

SignalRDeleteOptionalParams

Parâmetros opcionais.

SignalRFeature

Recurso de um recurso, que controla o comportamento de tempo de execução.

SignalRGetOptionalParams

Parâmetros opcionais.

SignalRKeys

Uma classe representa as chaves de acesso do recurso.

SignalRListByResourceGroupNextOptionalParams

Parâmetros opcionais.

SignalRListByResourceGroupOptionalParams

Parâmetros opcionais.

SignalRListBySubscriptionNextOptionalParams

Parâmetros opcionais.

SignalRListBySubscriptionOptionalParams

Parâmetros opcionais.

SignalRListKeysOptionalParams

Parâmetros opcionais.

SignalRListSkusOptionalParams

Parâmetros opcionais.

SignalRManagementClientOptionalParams

Parâmetros opcionais.

SignalRNetworkACLs

ACLs de rede para o recurso

SignalRPrivateEndpointConnections

Interface que representa um SignalRPrivateEndpointConnections.

SignalRPrivateEndpointConnectionsDeleteOptionalParams

Parâmetros opcionais.

SignalRPrivateEndpointConnectionsGetOptionalParams

Parâmetros opcionais.

SignalRPrivateEndpointConnectionsListNextOptionalParams

Parâmetros opcionais.

SignalRPrivateEndpointConnectionsListOptionalParams

Parâmetros opcionais.

SignalRPrivateEndpointConnectionsUpdateOptionalParams

Parâmetros opcionais.

SignalRPrivateLinkResources

Interface que representa um SignalRPrivateLinkResources.

SignalRPrivateLinkResourcesListNextOptionalParams

Parâmetros opcionais.

SignalRPrivateLinkResourcesListOptionalParams

Parâmetros opcionais.

SignalRRegenerateKeyOptionalParams

Parâmetros opcionais.

SignalRResource

Uma classe representa um recurso.

SignalRResourceList

Objeto que inclui uma matriz de recursos e um possível link para o próximo conjunto.

SignalRRestartOptionalParams

Parâmetros opcionais.

SignalRSharedPrivateLinkResources

Interface que representa um SignalRSharedPrivateLinkResources.

SignalRSharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SignalRSharedPrivateLinkResourcesDeleteOptionalParams

Parâmetros opcionais.

SignalRSharedPrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.

SignalRSharedPrivateLinkResourcesListNextOptionalParams

Parâmetros opcionais.

SignalRSharedPrivateLinkResourcesListOptionalParams

Parâmetros opcionais.

SignalRTlsSettings

Configurações de TLS para o recurso

SignalRUpdateOptionalParams

Parâmetros opcionais.

SignalRUsage

Objeto que descreve um uso específico dos recursos.

SignalRUsageList

Objeto que inclui uma matriz dos usos de recursos e um possível link para o próximo conjunto.

SignalRUsageName

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 por ARM.

UpstreamAuthSettings

Configurações de autenticação upstream. Se não estiver definida, nenhuma autenticação será usada para mensagens upstream.

UpstreamTemplate

Configurações de item de modelo upstream. Ele define a URL Upstream das solicitações de entrada. O modelo define o padrão do evento, o hub ou a categoria da solicitação de entrada que corresponde ao modelo de URL atual.

Usages

Interface que representa um Usos.

UsagesListNextOptionalParams

Parâmetros opcionais.

UsagesListOptionalParams

Parâmetros opcionais.

UserAssignedIdentityProperty

Propriedades da identidade atribuída pelo usuário.

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

FeatureFlags

Define valores para FeatureFlags.
KnownFeatureFlags pode ser usado de forma intercambiável com FeatureFlags, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ServiceMode
EnableConnectivityLogs
EnableMessagingLogs
EnableLiveTrace

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

SignalR
RawWebSockets

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

SignalRCheckNameAvailabilityResponse

Contém dados de resposta para a operação checkNameAvailability.

SignalRCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SignalRCustomCertificatesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SignalRCustomCertificatesGetResponse

Contém dados de resposta para a operação get.

SignalRCustomCertificatesListNextResponse

Contém dados de resposta para a operação listNext.

SignalRCustomCertificatesListResponse

Contém dados de resposta para a operação de lista.

SignalRCustomDomainsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SignalRCustomDomainsGetResponse

Contém dados de resposta para a operação get.

SignalRCustomDomainsListNextResponse

Contém dados de resposta para a operação listNext.

SignalRCustomDomainsListResponse

Contém dados de resposta para a operação de lista.

SignalRGetResponse

Contém dados de resposta para a operação get.

SignalRListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.

SignalRListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.

SignalRListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.

SignalRListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.

SignalRListKeysResponse

Contém dados de resposta para a operação listKeys.

SignalRListSkusResponse

Contém dados de resposta para a operação listSkus.

SignalRPrivateEndpointConnectionsGetResponse

Contém dados de resposta para a operação get.

SignalRPrivateEndpointConnectionsListNextResponse

Contém dados de resposta para a operação listNext.

SignalRPrivateEndpointConnectionsListResponse

Contém dados de resposta para a operação de lista.

SignalRPrivateEndpointConnectionsUpdateResponse

Contém dados de resposta para a operação de atualização.

SignalRPrivateLinkResourcesListNextResponse

Contém dados de resposta para a operação listNext.

SignalRPrivateLinkResourcesListResponse

Contém dados de resposta para a operação de lista.

SignalRRegenerateKeyResponse

Contém dados de resposta para a operação regenerateKey.

SignalRRequestType

Define valores para SignalRRequestType.
KnownSignalRRequestType pode ser usado de forma intercambiável com SignalRRequestType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ClientConnection
ServerConnection
RESTAPI
Trace

SignalRSharedPrivateLinkResourcesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SignalRSharedPrivateLinkResourcesGetResponse

Contém dados de resposta para a operação get.

SignalRSharedPrivateLinkResourcesListNextResponse

Contém dados de resposta para a operação listNext.

SignalRSharedPrivateLinkResourcesListResponse

Contém dados de resposta para a operação de lista.

SignalRSkuTier

Define valores para SignalRSkuTier.
KnownSignalRSkuTier pode ser usado de forma intercambiável com SignalRSkuTier, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Grátis
Básico
Standard
Premium

SignalRUpdateResponse

Contém dados de resposta para a operação de atualização.

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.

Enumerações

KnownACLAction

Os valores conhecidos de ACLAction que o serviço aceita.

KnownCreatedByType

Os valores conhecidos de CreatedByType que o serviço aceita.

KnownFeatureFlags

Os valores conhecidos de FeatureFlags 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.

KnownSignalRRequestType

Os valores conhecidos de SignalRRequestType que o serviço aceita.

KnownSignalRSkuTier

Os valores conhecidos de SignalRSkuTier que o serviço aceita.

KnownUpstreamAuthType

Os valores conhecidos de UpstreamAuthType 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.