Microsoft.SignalRService signalR/replicas 2023-08-01-preview

  • Article

Bicep resource definition

The signalR/replicas 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/replicas resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SignalRService/signalR/replicas@2023-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    regionEndpointEnabled: 'string'
    resourceStopped: 'string'
  }
}

Property values

signalR/replicas

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The billing information of the resource. ResourceSku
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: signalR
properties ReplicaProperties

ReplicaProperties

Name Description Value
regionEndpointEnabled Enable or disable the regional endpoint. Default to "Enabled".
When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.		 string
resourceStopped Stop or start the resource. Default to "false".
When it's true, the data plane of the resource is shutdown.
When it's false, the data plane of the resource is started.
 string

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'

ARM template resource definition

The signalR/replicas 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/replicas resource, add the following JSON to your template.

{
  "type": "Microsoft.SignalRService/signalR/replicas",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "regionEndpointEnabled": "string",
    "resourceStopped": "string"
  }
}

Property values

signalR/replicas

Name Description Value
type The resource type 'Microsoft.SignalRService/signalR/replicas'
apiVersion The resource api version '2023-08-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The billing information of the resource. ResourceSku
properties ReplicaProperties

ReplicaProperties

Name Description Value
regionEndpointEnabled Enable or disable the regional endpoint. Default to "Enabled".
When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.		 string
resourceStopped Stop or start the resource. Default to "false".
When it's true, the data plane of the resource is shutdown.
When it's false, the data plane of the resource is started.
 string

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'

Terraform (AzAPI provider) resource definition

The signalR/replicas 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/replicas resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR/replicas@2023-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      regionEndpointEnabled = "string"
      resourceStopped = "string"
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Property values

signalR/replicas

Name Description Value
type The resource type "Microsoft.SignalRService/signalR/replicas@2023-08-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: signalR
tags Resource tags. Dictionary of tag names and values.
sku The billing information of the resource. ResourceSku
properties ReplicaProperties

ReplicaProperties

Name Description Value
regionEndpointEnabled Enable or disable the regional endpoint. Default to "Enabled".
When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.		 string
resourceStopped Stop or start the resource. Default to "false".
When it's true, the data plane of the resource is shutdown.
When it's false, the data plane of the resource is started.
 string

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"