@azure/arm-signalr package

Classes

Interfaces

ApplicationFirewallSettings	Application firewall settings for the resource
ClientConnectionCountRule	A base class for client connection count rules
ClientTrafficControlRule	A base class for client traffic control rules
CustomCertificate	A custom certificate.
CustomCertificateProperties	Custom certificate properties.
CustomDomain	A custom domain
CustomDomainProperties	Properties of a custom domain.
Dimension	Specifications of the Dimension of metrics.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
IPRule	An IP rule
LiveTraceCategory	Live trace category configuration of a Microsoft.SignalRService resource.
LiveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
LogSpecification	Specifications of the Logs for Azure Monitoring.
ManagedIdentity	A class represent managed identities used for request and response
ManagedIdentitySettings	Managed identity settings for upstream.
MetricSpecification	Specifications of the Metrics for Azure Monitoring.
NameAvailability	Result of the request to check name availability. It contains a flag and possible reason of failure.
NameAvailabilityParameters	Data POST-ed to the nameAvailability action
NetworkACL	Network ACL
Operation	REST API operation supported by resource provider.
OperationDisplay	The object that describes a operation.
OperationProperties	Extra Operation properties.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	Private endpoint
PrivateEndpointACL	ACL for a private endpoint
PrivateEndpointConnection	A private endpoint connection to an azure resource
PrivateEndpointConnectionProperties	Private endpoint connection properties
PrivateLinkResource	Private link resource
PrivateLinkResourceProperties	Private link resource properties
PrivateLinkServiceConnectionState	Connection state of the private endpoint connection
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateKeyParameters	Parameters describes the request to regenerate access keys
Replica	A class represent a replica resource.
ReplicaProperties	model interface ReplicaProperties
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceLogCategory	Resource log category configuration of a Microsoft.SignalRService resource.
ResourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.
ResourceReference	Reference to a resource.
ResourceSku	The billing information of the resource.
RestorePollerOptions
RouteSettings	Route settings for the resource
ServerlessSettings	Serverless settings.
ServerlessUpstreamSettings	The settings for the Upstream when the service is in server-less mode.
ServiceSpecification	An object that describes a specification.
ShareablePrivateLinkResourceProperties	Describes the properties of a resource type that has been onboarded to private link service
ShareablePrivateLinkResourceType	Describes a resource type that has been onboarded to private link service
SharedPrivateLinkResource	Describes a Shared Private Link Resource
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource
SignalRCheckNameAvailabilityOptionalParams	Optional parameters.
SignalRCorsSettings	Cross-Origin Resource Sharing (CORS) settings.
SignalRCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomCertificatesCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomCertificatesDeleteOptionalParams	Optional parameters.
SignalRCustomCertificatesGetOptionalParams	Optional parameters.
SignalRCustomCertificatesListOptionalParams	Optional parameters.
SignalRCustomCertificatesOperations	Interface representing a SignalRCustomCertificates operations.
SignalRCustomDomainsCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomDomainsDeleteOptionalParams	Optional parameters.
SignalRCustomDomainsGetOptionalParams	Optional parameters.
SignalRCustomDomainsListOptionalParams	Optional parameters.
SignalRCustomDomainsOperations	Interface representing a SignalRCustomDomains operations.
SignalRDeleteOptionalParams	Optional parameters.
SignalRFeature	Feature of a resource, which controls the runtime behavior.
SignalRGetOptionalParams	Optional parameters.
SignalRKeys	A class represents the access keys of the resource.
SignalRListByResourceGroupOptionalParams	Optional parameters.
SignalRListBySubscriptionOptionalParams	Optional parameters.
SignalRListKeysOptionalParams	Optional parameters.
SignalRListReplicaSkusOptionalParams	Optional parameters.
SignalRListSkusOptionalParams	Optional parameters.
SignalRManagementClientOptionalParams	Optional parameters for the client.
SignalRNetworkACLs	Network ACLs for the resource
SignalROperations	Interface representing a SignalR operations.
SignalRPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsListOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsOperations	Interface representing a SignalRPrivateEndpointConnections operations.
SignalRPrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
SignalRPrivateLinkResourcesListOptionalParams	Optional parameters.
SignalRPrivateLinkResourcesOperations	Interface representing a SignalRPrivateLinkResources operations.
SignalRProperties	A class that describes the properties of the resource
SignalRRegenerateKeyOptionalParams	Optional parameters.
SignalRReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
SignalRReplicaSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
SignalRReplicaSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
SignalRReplicaSharedPrivateLinkResourcesOperations	Interface representing a SignalRReplicaSharedPrivateLinkResources operations.
SignalRReplicasCreateOrUpdateOptionalParams	Optional parameters.
SignalRReplicasDeleteOptionalParams	Optional parameters.
SignalRReplicasGetOptionalParams	Optional parameters.
SignalRReplicasListOptionalParams	Optional parameters.
SignalRReplicasOperations	Interface representing a SignalRReplicas operations.
SignalRReplicasRestartOptionalParams	Optional parameters.
SignalRReplicasUpdateOptionalParams	Optional parameters.
SignalRResource	A class representing a resource.
SignalRRestartOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesDeleteOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesOperations	Interface representing a SignalRSharedPrivateLinkResources operations.
SignalRTlsSettings	TLS settings for the resource
SignalRUpdateOptionalParams	Optional parameters.
SignalRUsage	Object that describes a specific usage of the resources.
SignalRUsageName	Localizable String object containing the name and a localized value.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	Describes an available sku."
SkuCapacity	Describes scaling information of a sku.
SkuList	The list skus operation response
SystemData	Metadata pertaining to creation and last modification of the resource.
ThrottleByJwtCustomClaimRule	Throttle the client connection by a custom JWT claim
ThrottleByJwtSignatureRule	Throttle the client connection by the JWT signature
ThrottleByUserIdRule	Throttle the client connection by the user ID
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrafficThrottleByJwtCustomClaimRule	Throttle the client traffic by a custom JWT claim
TrafficThrottleByJwtSignatureRule	Throttle the client traffic by the JWT signature
TrafficThrottleByUserIdRule	Throttle the client traffic by the user ID
UpstreamAuthSettings	Upstream auth settings. If not set, no auth is used for upstream messages.
UpstreamTemplate	Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.
UsagesListOptionalParams	Optional parameters.
UsagesOperations	Interface representing a Usages operations.
UserAssignedIdentityProperty	Properties of user assigned identity.

Type Aliases

ACLAction	Azure Networking ACL Action. KnownACLAction can be used interchangeably with ACLAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ClientConnectionCountRuleDiscriminator	Type of ClientConnectionCountRuleDiscriminator
ClientConnectionCountRuleUnion	Alias for ClientConnectionCountRuleUnion
ClientTrafficControlRuleDiscriminator	Type of ClientTrafficControlRuleDiscriminator
ClientTrafficControlRuleUnion	Alias for ClientTrafficControlRuleUnion
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
FeatureFlags	FeatureFlags is the supported features of Azure SignalR service. ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. KnownFeatureFlags can be used interchangeably with FeatureFlags, this enum contains the known values that the service supports. Known values supported by the service ServiceMode EnableConnectivityLogs EnableMessagingLogs EnableLiveTrace
KeyType	The type of access key. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service Primary Secondary Salt
ManagedIdentityType	Represents the identity type: systemAssigned, userAssigned, None KnownManagedIdentityType can be used interchangeably with ManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned
PrivateLinkServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ProvisioningState	Provisioning state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded Failed Canceled Running Creating Updating Deleting Moving
ScaleType	The scale type applicable to the sku. KnownScaleType can be used interchangeably with ScaleType, this enum contains the known values that the service supports. Known values supported by the service None Manual Automatic
ServiceKind	The kind of the service KnownServiceKind can be used interchangeably with ServiceKind, this enum contains the known values that the service supports. Known values supported by the service SignalR RawWebSockets
SharedPrivateLinkResourceStatus	Status of the shared private link resource KnownSharedPrivateLinkResourceStatus can be used interchangeably with SharedPrivateLinkResourceStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected Timeout
SignalRRequestType	The incoming request type to the service KnownSignalRRequestType can be used interchangeably with SignalRRequestType, this enum contains the known values that the service supports. Known values supported by the service ClientConnection ServerConnection RESTAPI Trace
SignalRSkuTier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. KnownSignalRSkuTier can be used interchangeably with SignalRSkuTier, this enum contains the known values that the service supports. Known values supported by the service Free Basic Standard Premium
UpstreamAuthType	Upstream auth type enum. KnownUpstreamAuthType can be used interchangeably with UpstreamAuthType, this enum contains the known values that the service supports. Known values supported by the service None ManagedIdentity

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownACLAction	Azure Networking ACL Action.
KnownClientConnectionCountRuleDiscriminator	Known values of ClientConnectionCountRuleDiscriminator that the service accepts.
KnownClientTrafficControlRuleDiscriminator	Known values of ClientTrafficControlRuleDiscriminator that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownFeatureFlags	FeatureFlags is the supported features of Azure SignalR service. ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature.
KnownKeyType	The type of access key.
KnownManagedIdentityType	Represents the identity type: systemAssigned, userAssigned, None
KnownPrivateLinkServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
KnownProvisioningState	Provisioning state of the resource.
KnownScaleType	The scale type applicable to the sku.
KnownServiceKind	The kind of the service
KnownSharedPrivateLinkResourceStatus	Status of the shared private link resource
KnownSignalRRequestType	The incoming request type to the service
KnownSignalRSkuTier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.
KnownUpstreamAuthType	Upstream auth type enum.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(SignalRManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(SignalRManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: SignalRManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: SignalRManagementClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-signalr package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(SignalRManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback