Microsoft.SignalRService signalR 2018-10-01
- Latest
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
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@2018-10-01' = {
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
hostNamePrefix: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.SignalRService/signalR
| Name | Description | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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) |
| name | The resource name | string (required) | ||||||||
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| sku | The billing information of the resource.(e.g. basic vs. standard) | ResourceSku | ||||||||
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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' |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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 |
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' (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 |
|---|
SignalRUpdateParametersTags
| 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": "2018-10-01",
"name": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"hostNamePrefix": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.SignalRService/signalR
| Name | Description | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| apiVersion | The api version | '2018-10-01' | ||||||||
| 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) |
| name | The resource name | string (required) | ||||||||
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| sku | The billing information of the resource.(e.g. basic vs. standard) | ResourceSku | ||||||||
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates | ||||||||
| type | The resource type | 'Microsoft.SignalRService/signalR' |
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' |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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 |
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' (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 |
|---|
SignalRUpdateParametersTags
| 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@2018-10-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
hostNamePrefix = "string"
}
})
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
}
Property values
Microsoft.SignalRService/signalR
| Name | Description | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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) |
| name | The resource name | string (required) | ||||||||
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| sku | The billing information of the resource.(e.g. basic vs. standard) | ResourceSku | ||||||||
| tags | Resource tags | Dictionary of tag names and values. | ||||||||
| type | The resource type | "Microsoft.SignalRService/signalR@2018-10-01" |
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' |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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 |
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' (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 |
|---|
SignalRUpdateParametersTags
| Name | Description | Value |
|---|