Microsoft.SignalRService SignalR 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-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
properties: {
hostNamePrefix: 'string'
}
}
Property values
SignalR
| Name | Description | Value |
|---|---|---|
| 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 resource.(e.g. basic vs. standard) | ResourceSku |
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Name | Description | Value |
|---|---|---|
| hostNamePrefix | Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net. |
string |
ResourceSku
| Name | Description | Value |
|---|---|---|
| capacity | Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. |
int |
| family | Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified) | string (required) |
| size | Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | Optional tier of this particular SKU. Basic is deprecated, use Standard instead for Basic tier |
'Basic' 'Free' 'Premium' 'Standard' |
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. |
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-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string"
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"hostNamePrefix": "string"
}
}
Property values
SignalR
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.SignalRService/SignalR' |
| apiVersion | The resource api version | '2018-03-01-preview' |
| 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 resource.(e.g. basic vs. standard) | ResourceSku |
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Name | Description | Value |
|---|---|---|
| hostNamePrefix | Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net. |
string |
ResourceSku
| Name | Description | Value |
|---|---|---|
| capacity | Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. |
int |
| family | Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified) | string (required) |
| size | Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | Optional tier of this particular SKU. Basic is deprecated, use Standard instead for Basic tier |
'Basic' 'Free' 'Premium' 'Standard' |
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-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
body = jsonencode({
properties = {
hostNamePrefix = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
Property values
SignalR
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.SignalRService/SignalR@2018-03-01-preview" |
| 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) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | A list of key value pairs that describe the resource. | Dictionary of tag names and values. |
| sku | The billing information of the resource.(e.g. basic vs. standard) | ResourceSku |
| properties | Settings used to provision or configure the resource | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Name | Description | Value |
|---|---|---|
| hostNamePrefix | Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net. |
string |
ResourceSku
| Name | Description | Value |
|---|---|---|
| capacity | Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. |
int |
| family | Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified) | string (required) |
| size | Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | Optional tier of this particular SKU. Basic is deprecated, use Standard instead for Basic tier |
"Basic" "Free" "Premium" "Standard" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for