Microsoft.SignalRService signalR

The signalR resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.SignalRService/signalR resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.SignalRService/signalR@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    cors: {
      allowedOrigins: [ 'string' ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {}
        value: 'string'
      }
    ]
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [ 'string' ]
          deny: [ 'string' ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [ 'string' ]
        deny: [ 'string' ]
      }
    }
    publicNetworkAccess: 'string'
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

Property values

signalR

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.SignalRService/signalR'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-06-01-preview'
name The resource name string (required)
location The GEO location of the resource. e.g. West US , East US , North Central US , South Central US. string
tags Tags of the service which is a list of key value pairs that describe the resource. Dictionary of tag names and values. See Tags in templates
sku The billing information of the resource. ResourceSku
kind The kind of the service - e.g. "SignalR" for "Microsoft.SignalRService/SignalR" 'RawWebSockets'
'SignalR'
identity A class represent managed identities used for request and response ManagedIdentity
properties A class that describes the properties of the resource SignalRProperties

ManagedIdentity

Name Description Value
type Represent the identity type: systemAssigned, userAssigned, None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Get or set the user assigned identities object

SignalRProperties

Name Description Value
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings
disableAadAuth DisableLocalAuth
Enable or disable aad auth
When set as true, connection with AuthType=aad won't work.
bool
disableLocalAuth DisableLocalAuth
Enable or disable local auth with AccessKey
When set as true, connection with AccessKey=xxx won't work.
bool
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.
SignalRFeature[]
networkACLs Network ACLs for the resource SignalRNetworkACLs
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.
string
tls TLS settings for the resource SignalRTlsSettings
upstream The settings for the Upstream when the service is in server-less mode. ServerlessUpstreamSettings

SignalRCorsSettings

Name Description Value
allowedOrigins Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. string[]

SignalRFeature

Name Description Value
flag 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.
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode'
properties Optional properties related to this feature. object
value Value of the feature flag. See Azure SignalR service document /azure/azure-signalr/ for allowed values. string (required)

SignalRNetworkACLs

Name Description Value
defaultAction Default action when no other rule matches 'Allow'
'Deny'
privateEndpoints ACLs for requests from private endpoints PrivateEndpointACL[]
publicNetwork Network ACL NetworkACL

PrivateEndpointACL

Name Description Value
allow Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. String array containing any of:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. String array containing any of:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
name Name of the private endpoint connection string (required)

NetworkACL

Name Description Value
allow Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. String array containing any of:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. String array containing any of:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

SignalRTlsSettings

Name Description Value
clientCertEnabled Request client certificate during TLS handshake if enabled bool

ServerlessUpstreamSettings

Name Description Value
templates Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. UpstreamTemplate[]

UpstreamTemplate

Name Description Value
auth Upstream auth settings. UpstreamAuthSettings
categoryPattern Gets or sets the matching pattern for category names. If not set, it matches any category.
There are 3 kind of patterns supported:
1. "*", it to matches any category name
2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages"
3. The single category name, for example, "connections", it matches the category "connections"
string
eventPattern Gets or sets the matching pattern for event names. If not set, it matches any event.
There are 3 kind of patterns supported:
1. "*", it to matches any event name
2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect"
3. The single event name, for example, "connect", it matches "connect"
string
hubPattern Gets or sets the matching pattern for hub names. If not set, it matches any hub.
There are 3 kind of patterns supported:
1. "*", it to matches any hub name
2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2"
3. The single hub name, for example, "hub1", it matches "hub1"
string
urlTemplate Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.
For example, if the urlTemplate is http://example.com/{hub}/api/{event}, with a client request from hub chat connects, it will first POST to this URL: http://example.com/chat/api/connect.
string (required)

UpstreamAuthSettings

Name Description Value
managedIdentity Managed identity settings for upstream. ManagedIdentitySettings
type Gets or sets the type of auth. None or ManagedIdentity is supported now. 'ManagedIdentity'
'None'

ManagedIdentitySettings

Name Description Value
resource The Resource indicating the App ID URI of the target resource.
It also appears in the aud (audience) claim of the issued token.
string

ResourceSku

Name Description Value
capacity Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed:
Free: 1
Standard: 1,2,5,10,20,50,100
int
name The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1
string (required)
tier Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.
'Basic'
'Free'
'Premium'
'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy an Azure SignalR service

Deploy to Azure
This template creates an Azure SignalR Service using a template.