SignalRProperties interface

Package:

@azure/arm-signalr

A class that describes the properties of the resource

Properties

applicationFirewall	Application firewall settings for the resource
cors	Cross-Origin Resource Sharing (CORS) settings.
disableAadAuth	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
externalIP	The publicly accessible IP of the resource.
features	List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
hostName	FQDN of the service instance.
hostNamePrefix	Deprecated.
liveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
networkACLs	Network ACLs for the resource
privateEndpointConnections	Private endpoint connections to the resource.
provisioningState	Provisioning state of the resource.
publicNetworkAccess	Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
publicPort	The publicly accessible port of the resource which is designed for browser/client side usage.
regionEndpointEnabled	Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.
resourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.
resourceStopped	Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.
routeSettings	Route settings for the resource
serverless	Serverless settings.
serverPort	The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources	The list of shared private link resources.
tls	TLS settings for the resource
upstream	The settings for the Upstream when the service is in server-less mode.
version	Version of the resource. Probably you need the same or higher version of client SDKs.

Property Details

applicationFirewall

Application firewall settings for the resource

applicationFirewall?: ApplicationFirewallSettings

Property Value

ApplicationFirewallSettings

cors

Cross-Origin Resource Sharing (CORS) settings.

cors?: SignalRCorsSettings

Property Value

SignalRCorsSettings

disableAadAuth

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.

disableAadAuth?: boolean

Property Value

boolean

disableLocalAuth

DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.

disableLocalAuth?: boolean

Property Value

boolean

externalIP

The publicly accessible IP of the resource.

externalIP?: string

Property Value

string

features

List of the featureFlags.

FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

features?: SignalRFeature[]

Property Value

SignalRFeature[]

hostName

FQDN of the service instance.

hostName?: string

Property Value

string

hostNamePrefix

Deprecated.

hostNamePrefix?: string

Property Value

string

liveTraceConfiguration

Live trace configuration of a Microsoft.SignalRService resource.

liveTraceConfiguration?: LiveTraceConfiguration

Property Value

LiveTraceConfiguration

networkACLs

Network ACLs for the resource

networkACLs?: SignalRNetworkACLs

Property Value

SignalRNetworkACLs

privateEndpointConnections

Private endpoint connections to the resource.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the resource.

provisioningState?: string

Property Value

string

publicNetworkAccess

Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.

publicNetworkAccess?: string

Property Value

string

publicPort

The publicly accessible port of the resource which is designed for browser/client side usage.

publicPort?: number

Property Value

number

regionEndpointEnabled

Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.

regionEndpointEnabled?: string

Property Value

string

resourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.

resourceLogConfiguration?: ResourceLogConfiguration

Property Value

ResourceLogConfiguration

resourceStopped

Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.

resourceStopped?: string

Property Value

string

routeSettings

Route settings for the resource

routeSettings?: RouteSettings

Property Value

RouteSettings

serverless

Serverless settings.

serverless?: ServerlessSettings

Property Value

ServerlessSettings

serverPort

The publicly accessible port of the resource which is designed for customer server side usage.

serverPort?: number

Property Value

number

sharedPrivateLinkResources

The list of shared private link resources.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

SharedPrivateLinkResource[]

tls

TLS settings for the resource

tls?: SignalRTlsSettings

Property Value

SignalRTlsSettings

upstream

The settings for the Upstream when the service is in server-less mode.

upstream?: ServerlessUpstreamSettings

Property Value

ServerlessUpstreamSettings

version

Version of the resource. Probably you need the same or higher version of client SDKs.

version?: string

Property Value

string