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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.SignalRService/webPubSub@2023-02-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
disableAadAuth: bool
disableLocalAuth: bool
liveTraceConfiguration: {
categories: [
{
enabled: 'string'
name: 'string'
}
]
enabled: 'string'
}
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
resourceLogConfiguration: {
categories: [
{
enabled: 'string'
name: 'string'
}
]
}
tls: {
clientCertEnabled: bool
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.SignalRService/webPubSub
| Name | Description | Value |
|---|---|---|
| identity | A class represent managed identities used for request and response | ManagedIdentity |
| location | The GEO location of the resource. e.g. West US | East US | North Central US | South Central US. | string |
| name | The resource name | string (required) |
| properties | A class that describes the properties of the resource | WebPubSubProperties |
| sku | The billing information of the resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
LiveTraceCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
LiveTraceConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | LiveTraceCategory[] |
| enabled | Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. |
string |
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | Represents the identity type: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | Get or set the user assigned identities | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| name | Name of the private endpoint connection | string (required) |
ResourceLogCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
ResourceLogConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | ResourceLogCategory[] |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentityProperty
| Name | Description | Value |
|---|
WebPubSubNetworkACLs
| Name | Description | Value |
|---|---|---|
| defaultAction | Azure Networking ACL Action. | 'Allow' 'Deny' |
| privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
| publicNetwork | Network ACL | NetworkACL |
WebPubSubProperties
| Name | Description | Value |
|---|---|---|
| disableAadAuth | DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. |
bool |
| disableLocalAuth | DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. |
bool |
| liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
| networkACLs | Network ACLs for the resource | WebPubSubNetworkACLs |
| publicNetworkAccess | Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. |
string |
| resourceLogConfiguration | Resource log configuration of a Microsoft.SignalRService resource. | ResourceLogConfiguration |
| tls | TLS settings for the resource | WebPubSubTlsSettings |
WebPubSubTlsSettings
| Name | Description | Value |
|---|---|---|
| clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| SignalR Web PubSub Service | AVM Resource Module for SignalR Web PubSub Service |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create Azure Web PubSub by using Bicep | Azure Web PubSub Service helps you build real-time messaging web applications using WebSockets and the publish-subscribe pattern. This uses Bicep language to create and configure a Web PubSub resource. You can use this template to conveniently deploy Web PubSub for a tutorial or testing, or as a building block for more complex deployments with Web PubSub. |
ARM template resource definition
The webPubSub 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 resource, add the following JSON to your template.
{
"type": "Microsoft.SignalRService/webPubSub",
"apiVersion": "2023-02-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"liveTraceConfiguration": {
"categories": [
{
"enabled": "string",
"name": "string"
}
],
"enabled": "string"
},
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"resourceLogConfiguration": {
"categories": [
{
"enabled": "string",
"name": "string"
}
]
},
"tls": {
"clientCertEnabled": "bool"
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.SignalRService/webPubSub
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-02-01' |
| identity | A class represent managed identities used for request and response | ManagedIdentity |
| location | The GEO location of the resource. e.g. West US | East US | North Central US | South Central US. | string |
| name | The resource name | string (required) |
| properties | A class that describes the properties of the resource | WebPubSubProperties |
| 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' |
LiveTraceCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
LiveTraceConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | LiveTraceCategory[] |
| enabled | Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. |
string |
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | Represents the identity type: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | Get or set the user assigned identities | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| name | Name of the private endpoint connection | string (required) |
ResourceLogCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
ResourceLogConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | ResourceLogCategory[] |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentityProperty
| Name | Description | Value |
|---|
WebPubSubNetworkACLs
| Name | Description | Value |
|---|---|---|
| defaultAction | Azure Networking ACL Action. | 'Allow' 'Deny' |
| privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
| publicNetwork | Network ACL | NetworkACL |
WebPubSubProperties
| Name | Description | Value |
|---|---|---|
| disableAadAuth | DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. |
bool |
| disableLocalAuth | DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. |
bool |
| liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
| networkACLs | Network ACLs for the resource | WebPubSubNetworkACLs |
| publicNetworkAccess | Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. |
string |
| resourceLogConfiguration | Resource log configuration of a Microsoft.SignalRService resource. | ResourceLogConfiguration |
| tls | TLS settings for the resource | WebPubSubTlsSettings |
WebPubSubTlsSettings
| Name | Description | Value |
|---|---|---|
| clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create Azure Web PubSub by using Bicep |
Azure Web PubSub Service helps you build real-time messaging web applications using WebSockets and the publish-subscribe pattern. This uses Bicep language to create and configure a Web PubSub resource. You can use this template to conveniently deploy Web PubSub for a tutorial or testing, or as a building block for more complex deployments with Web PubSub. |
Terraform (AzAPI provider) resource definition
The webPubSub 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/webPubSub@2023-02-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
disableAadAuth = bool
disableLocalAuth = bool
liveTraceConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
enabled = "string"
}
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
resourceLogConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
}
tls = {
clientCertEnabled = bool
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.SignalRService/webPubSub
| Name | Description | Value |
|---|---|---|
| identity | A class represent managed identities used for request and response | ManagedIdentity |
| location | The GEO location of the resource. e.g. West US | East US | North Central US | South Central US. | string |
| name | The resource name | string (required) |
| properties | A class that describes the properties of the resource | WebPubSubProperties |
| sku | The billing information of the resource. | ResourceSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.SignalRService/webPubSub@2023-02-01" |
LiveTraceCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
LiveTraceConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | LiveTraceCategory[] |
| enabled | Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. |
string |
ManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | Represents the identity type: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | Get or set the user assigned identities | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
| Name | Description | Value |
|---|---|---|
| allow | Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| deny | Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. | String array containing any of: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
| name | Name of the private endpoint connection | string (required) |
ResourceLogCategory
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. |
string |
| name | Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
ResourceLogConfiguration
| Name | Description | Value |
|---|---|---|
| categories | Gets or sets the list of category configurations. | ResourceLogCategory[] |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentityProperty
| Name | Description | Value |
|---|
WebPubSubNetworkACLs
| Name | Description | Value |
|---|---|---|
| defaultAction | Azure Networking ACL Action. | 'Allow' 'Deny' |
| privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
| publicNetwork | Network ACL | NetworkACL |
WebPubSubProperties
| Name | Description | Value |
|---|---|---|
| disableAadAuth | DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. |
bool |
| disableLocalAuth | DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. |
bool |
| liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
| networkACLs | Network ACLs for the resource | WebPubSubNetworkACLs |
| publicNetworkAccess | Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. |
string |
| resourceLogConfiguration | Resource log configuration of a Microsoft.SignalRService resource. | ResourceLogConfiguration |
| tls | TLS settings for the resource | WebPubSubTlsSettings |
WebPubSubTlsSettings
| Name | Description | Value |
|---|---|---|
| clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |