Package version:

Interface SignalRResource

A class represent a resource.

Hierarchy

Properties

cors? disableAadAuth? disableLocalAuth? externalIP? features? hostName? hostNamePrefix? id? identity? kind? liveTraceConfiguration? location? name? networkACLs? privateEndpointConnections? provisioningState? publicNetworkAccess? publicPort? resourceLogConfiguration? serverPort? serverless? sharedPrivateLinkResources? sku? systemData? tags? tls? type? upstream? version?

Properties

Optional cors

cors?: SignalRCorsSettings

Cross-Origin Resource Sharing (CORS) settings.

Optional disableAadAuth

disableAadAuth?: boolean

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

Optional disableLocalAuth

disableLocalAuth?: boolean

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

Optional Readonly externalIP

externalIP?: string

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

Optional features

features?: SignalRFeature[]

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.

Optional Readonly hostName

hostName?: string

FQDN of the service instance. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly hostNamePrefix

hostNamePrefix?: string

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

Optional Readonly id

id?: string

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

Optional identity

identity?: ManagedIdentity

A class represent managed identities used for request and response

Optional kind

kind?: string

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

Optional liveTraceConfiguration

liveTraceConfiguration?: LiveTraceConfiguration

Live trace configuration of a Microsoft.SignalRService resource.

Optional location

location?: string

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

Optional Readonly name

name?: string

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

Optional networkACLs

networkACLs?: SignalRNetworkACLs

Network ACLs for the resource

Optional Readonly privateEndpointConnections

privateEndpointConnections?: PrivateEndpointConnection[]

Private endpoint connections to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly provisioningState

provisioningState?: string

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

Optional publicNetworkAccess

publicNetworkAccess?: string

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.

Optional Readonly publicPort

publicPort?: number

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.

Optional resourceLogConfiguration

resourceLogConfiguration?: ResourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.

Optional Readonly serverPort

serverPort?: number

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.

Optional serverless

serverless?: ServerlessSettings

Serverless settings.

Optional Readonly sharedPrivateLinkResources

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

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

Optional sku

sku?: ResourceSku

The billing information of the resource.

Optional Readonly systemData

systemData?: 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.

Optional tags

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

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

Type declaration

  • [propertyName: string]: string

Optional tls

tls?: SignalRTlsSettings

TLS settings for the resource

Optional Readonly type

type?: string

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.

Optional upstream

upstream?: ServerlessUpstreamSettings

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

Optional Readonly version

version?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc