Share via

Microsoft.SignalRService SignalR 2018-03-01-preview

  • Article

Bicep resource definition

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

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' = {
  location: 'string'
  name: 'string'
  properties: {
    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. 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'

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

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:

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",
  "properties": {
    "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-03-01-preview'
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. 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'

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

SignalRUpdateParametersTags

Name Description Value

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.

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"
  body = jsonencode({
    properties = {
      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-03-01-preview"

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'

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

SignalRUpdateParametersTags

Name Description Value