Microsoft.SignalRService signalR template reference

Template format

To create a Microsoft.SignalRService/signalR resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2018-10-01",
  "tags": {},
  "sku": {
    "name": "string",
    "tier": "string",
    "size": "string",
    "family": "string",
    "capacity": "integer"
  },
  "properties": {
    "hostNamePrefix": "string",
    "features": [
      {
        "flag": "string",
        "value": "string",
        "properties": {}
      }
    ],
    "cors": {
      "allowedOrigins": [
        "string"
      ]
    }
  },
  "location": "string"
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.SignalRService/signalR object

Name Type Required Value
name string Yes The name of the SignalR resource.
type enum Yes Microsoft.SignalRService/signalR
apiVersion enum Yes 2018-10-01
tags object No A list of key value pairs that describe the resource.
sku object No The billing information of the resource.(e.g. basic vs. standard) - ResourceSku object
properties object Yes Settings used to provision or configure the resource - SignalRCreateOrUpdateProperties object
location string Yes 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.

ResourceSku object

Name Type Required Value
name string Yes The name of the SKU. Required.



Allowed values: Standard_S1, Free_F1
tier enum No Optional tier of this particular SKU. 'Standard' or 'Free'.



Basic is deprecated, use Standard instead. - Free, Basic, Standard, Premium
size string No Optional string. For future use.
family string No Optional string. For future use.
capacity integer No 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

SignalRCreateOrUpdateProperties object

Name Type Required Value
hostNamePrefix string No Prefix for the hostName of the SignalR service. Retained for future use.

The hostname will be of format: <hostNamePrefix>.service.signalr.net.
features array No 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 object
cors object No Cross-Origin Resource Sharing (CORS) settings. - SignalRCorsSettings object

SignalRFeature object

Name Type Required Value
flag enum Yes 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. - ServiceMode or EnableConnectivityLogs
value string Yes Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
properties object No Optional properties related to this feature.

SignalRCorsSettings object

Name Type Required Value
allowedOrigins array No 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

Quickstart templates

The following quickstart templates deploy this resource type.