SignalRResource interface

Package:

@azure/arm-signalr

A class represent a resource.

Extends

TrackedResource

Properties

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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
hostNamePrefix	Deprecated. NOTE: This property will not be serialized. It can only be populated by the server.
identity	A class represent managed identities used for request and response
kind	The kind of the service, it can be SignalR or RawWebSockets
liveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
networkACLs	Network ACLs for the resource
privateEndpointConnections	Private endpoint connections to the resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
resourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.
serverless	Serverless settings.
serverPort	The publicly accessible port of the resource which is designed for customer server side usage. NOTE: This property will not be serialized. It can only be populated by the server.
sharedPrivateLinkResources	The list of shared private link resources. NOTE: This property will not be serialized. It can only be populated by the server.
sku	The billing information of the resource.
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource Id for the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
name	The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags of the service which is a list of key value pairs that describe the resource.
type	The type of the resource - e.g. "Microsoft.SignalRService/SignalR" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

hostNamePrefix

Deprecated. NOTE: This property will not be serialized. It can only be populated by the server.

hostNamePrefix?: string

Property Value

string

identity

A class represent managed identities used for request and response

identity?: ManagedIdentity

Property Value

ManagedIdentity

kind

The kind of the service, it can be SignalR or RawWebSockets

kind?: 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. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

publicPort?: number

Property Value

number

resourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.

resourceLogConfiguration?: ResourceLogConfiguration

Property Value

ResourceLogConfiguration

serverless

Serverless settings.

serverless?: ServerlessSettings

Property Value

ServerlessSettings

serverPort

The publicly accessible port of the resource which is designed for customer server side usage. NOTE: This property will not be serialized. It can only be populated by the server.

serverPort?: number

Property Value

number

sharedPrivateLinkResources

The list of shared private link resources. NOTE: This property will not be serialized. It can only be populated by the server.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

SharedPrivateLinkResource[]

sku

The billing information of the resource.

sku?: ResourceSku

Property Value

ResourceSku

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

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. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource Id for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.

location?: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Tags of the service which is a list of key value pairs that describe the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource - e.g. "Microsoft.SignalRService/SignalR" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type