Microsoft.SignalRService signalR 2023-02-01

Article
10/25/2024

Bicep resource definition

The signalR resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.SignalRService/signalR@2023-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    serverless: {
      connectionTimeoutInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

LiveTraceCategory

Name	Description	Value
enabled	Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

LiveTraceConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	LiveTraceCategory[]
enabled	Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.	string

ManagedIdentity

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

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

ManagedIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.SignalRService/signalR

Name	Description	Value
identity	A class represent managed identities used for request and response	ManagedIdentity
kind	The kind of the service, it can be SignalR or RawWebSockets	'RawWebSockets' 'SignalR'
location	The GEO location of the resource. e.g. West US	East US	North Central US	South Central US.	string
name	The resource name	string (required)
properties	A class that describes the properties of the resource	SignalRProperties
sku	The billing information of the resource.	ResourceSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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'

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)

ResourceLogCategory

Name	Description	Value
enabled	Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

ResourceLogConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	ResourceLogCategory[]

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,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;	int
name	The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1	string (required)
tier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.	'Basic' 'Free' 'Premium' 'Standard'

ServerlessSettings

Name	Description	Value
connectionTimeoutInSeconds	Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.	int Constraints: Min value = 1 Max value = 120

ServerlessUpstreamSettings

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

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' (required)
properties	Optional properties related to this feature.	SignalRFeatureProperties
value	Value of the feature flag. See Azure SignalR service document /azure/azure-signalr/ for allowed values.	string Constraints: Min length = 1 Max length = 1 (required)

SignalRFeatureProperties

Name	Description	Value

SignalRNetworkACLs

Name	Description	Value
defaultAction	Azure Networking ACL Action.	'Allow' 'Deny'
privateEndpoints	ACLs for requests from private endpoints	PrivateEndpointACL[]
publicNetwork	Network ACL	NetworkACL

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[]
liveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.	LiveTraceConfiguration
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
resourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.	ResourceLogConfiguration
serverless	Serverless settings.	ServerlessSettings
tls	TLS settings for the resource	SignalRTlsSettings
upstream	The settings for the Upstream when the service is in server-less mode.	ServerlessUpstreamSettings

SignalRTlsSettings

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

TrackedResourceTags

Name	Description	Value

UpstreamAuthSettings

Name	Description	Value
managedIdentity	Managed identity settings for upstream.	ManagedIdentitySettings
type	Upstream auth type enum.	'ManagedIdentity' 'None'

UpstreamTemplate

Name	Description	Value
auth	Upstream auth settings. If not set, no auth is used for upstream messages.	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)

UserAssignedIdentityProperty

Name	Description	Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Deploy an Azure SignalR service	This template creates an Azure SignalR Service using a template.

ARM template resource definition

The signalR resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

LiveTraceCategory

Name	Description	Value
enabled	Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

LiveTraceConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	LiveTraceCategory[]
enabled	Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.	string

ManagedIdentity

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

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

ManagedIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.SignalRService/signalR

Name	Description	Value
apiVersion	The api version	'2023-02-01'
identity	A class represent managed identities used for request and response	ManagedIdentity
kind	The kind of the service, it can be SignalR or RawWebSockets	'RawWebSockets' 'SignalR'
location	The GEO location of the resource. e.g. West US	East US	North Central US	South Central US.	string
name	The resource name	string (required)
properties	A class that describes the properties of the resource	SignalRProperties
sku	The billing information of the resource.	ResourceSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.SignalRService/signalR'

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'

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)

ResourceLogCategory

Name	Description	Value
enabled	Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

ResourceLogConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	ResourceLogCategory[]

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,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;	int
name	The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1	string (required)
tier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.	'Basic' 'Free' 'Premium' 'Standard'

ServerlessSettings

Name	Description	Value
connectionTimeoutInSeconds	Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.	int Constraints: Min value = 1 Max value = 120

ServerlessUpstreamSettings

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

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' (required)
properties	Optional properties related to this feature.	SignalRFeatureProperties
value	Value of the feature flag. See Azure SignalR service document /azure/azure-signalr/ for allowed values.	string Constraints: Min length = 1 Max length = 1 (required)

SignalRFeatureProperties

Name	Description	Value

SignalRNetworkACLs

Name	Description	Value
defaultAction	Azure Networking ACL Action.	'Allow' 'Deny'
privateEndpoints	ACLs for requests from private endpoints	PrivateEndpointACL[]
publicNetwork	Network ACL	NetworkACL

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[]
liveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.	LiveTraceConfiguration
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
resourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.	ResourceLogConfiguration
serverless	Serverless settings.	ServerlessSettings
tls	TLS settings for the resource	SignalRTlsSettings
upstream	The settings for the Upstream when the service is in server-less mode.	ServerlessUpstreamSettings

SignalRTlsSettings

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

TrackedResourceTags

Name	Description	Value

UpstreamAuthSettings

Name	Description	Value
managedIdentity	Managed identity settings for upstream.	ManagedIdentitySettings
type	Upstream auth type enum.	'ManagedIdentity' 'None'

UpstreamTemplate

Name	Description	Value
auth	Upstream auth settings. If not set, no auth is used for upstream messages.	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)

UserAssignedIdentityProperty

Name	Description	Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy an Azure SignalR service	This template creates an Azure SignalR Service using a template.

Terraform (AzAPI provider) resource definition

The signalR resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      serverless = {
        connectionTimeoutInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Property values

LiveTraceCategory

Name	Description	Value
enabled	Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

LiveTraceConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	LiveTraceCategory[]
enabled	Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.	string

ManagedIdentity

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

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

ManagedIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.SignalRService/signalR

Name	Description	Value
identity	A class represent managed identities used for request and response	ManagedIdentity
kind	The kind of the service, it can be SignalR or RawWebSockets	'RawWebSockets' 'SignalR'
location	The GEO location of the resource. e.g. West US	East US	North Central US	South Central US.	string
name	The resource name	string (required)
properties	A class that describes the properties of the resource	SignalRProperties
sku	The billing information of the resource.	ResourceSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.SignalRService/signalR@2023-02-01"

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'

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)

ResourceLogCategory

Name	Description	Value
enabled	Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.	string
name	Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.	string

ResourceLogConfiguration

Name	Description	Value
categories	Gets or sets the list of category configurations.	ResourceLogCategory[]

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,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;	int
name	The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1	string (required)
tier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.	'Basic' 'Free' 'Premium' 'Standard'

ServerlessSettings

Name	Description	Value
connectionTimeoutInSeconds	Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.	int Constraints: Min value = 1 Max value = 120

ServerlessUpstreamSettings

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

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' (required)
properties	Optional properties related to this feature.	SignalRFeatureProperties
value	Value of the feature flag. See Azure SignalR service document /azure/azure-signalr/ for allowed values.	string Constraints: Min length = 1 Max length = 1 (required)

SignalRFeatureProperties

Name	Description	Value

SignalRNetworkACLs

Name	Description	Value
defaultAction	Azure Networking ACL Action.	'Allow' 'Deny'
privateEndpoints	ACLs for requests from private endpoints	PrivateEndpointACL[]
publicNetwork	Network ACL	NetworkACL

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[]
liveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.	LiveTraceConfiguration
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
resourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.	ResourceLogConfiguration
serverless	Serverless settings.	ServerlessSettings
tls	TLS settings for the resource	SignalRTlsSettings
upstream	The settings for the Upstream when the service is in server-less mode.	ServerlessUpstreamSettings

SignalRTlsSettings

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

TrackedResourceTags

Name	Description	Value

UpstreamAuthSettings

Name	Description	Value
managedIdentity	Managed identity settings for upstream.	ManagedIdentitySettings
type	Upstream auth type enum.	'ManagedIdentity' 'None'

UpstreamTemplate

Name	Description	Value
auth	Upstream auth settings. If not set, no auth is used for upstream messages.	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)

UserAssignedIdentityProperty

Name	Description	Value

Share via

Microsoft.SignalRService signalR 2023-02-01

Bicep resource definition

Resource format

Property values

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServerlessSettings

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings

UpstreamTemplate

UserAssignedIdentityProperty

Quickstart samples

ARM template resource definition

Resource format

Property values

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServerlessSettings

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings

UpstreamTemplate

UserAssignedIdentityProperty

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServerlessSettings

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings