Microsoft.SignalRService signalR 2018-10-01

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@2018-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {}
        value: 'string'
      }
    ]
    hostNamePrefix: '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.
'2018-10-01'
name The resource name string (required)

Character limit: 3-63

Valid characters:
Alphanumerics and hyphens.

Start with letter. End with letter or number.

Resource name must be unique across Azure.
location Azure GEO region: e.g. West US , East US , North Central US , South Central US , West Europe , North Europe , East Asia , Southeast Asia , etc.
The geo region of a resource never changes after it is created.
string (required)
tags 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 SignalR resource. ResourceSku
properties Settings used to provision or configure the resource. SignalRCreateOrUpdateProperties

SignalRCreateOrUpdateProperties

Name Description Value
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings
features List of SignalR featureFlags. e.g. ServiceMode.

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, SignalR service will use its globally default value.
But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefix for the hostName of the SignalR service. Retained for future use.
The hostname will be of format: <hostNamePrefix>.service.signalr.net.
string

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.
'EnableConnectivityLogs'
'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)

ResourceSku

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

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

Allowed values: Standard_S1, Free_F1
string (required)
size Optional string. For future use. string
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.