Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The webPubSub/replicas 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/webPubSub/replicas resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.SignalRService/webPubSub/replicas@2025-12-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
regionEndpointEnabled: 'string'
resourceStopped: 'string'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.SignalRService/webPubSub/replicas
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (required) |
| 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: webPubSub |
| properties | ReplicaProperties | |
| sku | The billing information of the resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; |
int |
| name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
string (required) |
| tier | Optional tier of this particular SKU. 'Standard' or 'Free'.Basic is deprecated, use Standard instead. |
'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The webPubSub/replicas 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.
Usage Examples
Resource format
To create a Microsoft.SignalRService/webPubSub/replicas resource, add the following JSON to your template.
{
"type": "Microsoft.SignalRService/webPubSub/replicas",
"apiVersion": "2025-12-01-preview",
"name": "string",
"location": "string",
"properties": {
"regionEndpointEnabled": "string",
"resourceStopped": "string"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.SignalRService/webPubSub/replicas
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-12-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (required) |
| properties | ReplicaProperties | |
| 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/webPubSub/replicas' |
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 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; |
int |
| name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
string (required) |
| tier | Optional tier of this particular SKU. 'Standard' or 'Free'.Basic is deprecated, use Standard instead. |
'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The webPubSub/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/webPubSub/replicas resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/webPubSub/replicas@2025-12-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
regionEndpointEnabled = "string"
resourceStopped = "string"
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.SignalRService/webPubSub/replicas
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: webPubSub |
| properties | ReplicaProperties | |
| sku | The billing information of the resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.SignalRService/webPubSub/replicas@2025-12-01-preview" |
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 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; |
int |
| name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
string (required) |
| tier | Optional tier of this particular SKU. 'Standard' or 'Free'.Basic is deprecated, use Standard instead. |
'Basic' 'Free' 'Premium' 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|