Microsoft.SignalRService webPubSub 2021-09-01-preview
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@2021-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
disableAadAuth: bool
disableLocalAuth: bool
eventHandler: {
items: {
{customized property}: [
{
auth: {
managedIdentity: {
resource: 'string'
}
type: 'string'
}
systemEventPattern: 'string'
urlTemplate: 'string'
userEventPattern: 'string'
}
]
}
}
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'
tls: {
clientCertEnabled: bool
}
}
}
Property values
webPubSub
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | The GEO location of the resource. e.g. West US , East US , North Central US , South Central US. | string |
tags | Tags of the service which is 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. Free, Standard) | ResourceSku |
identity | The managed identity response | ManagedIdentity |
properties | Settings used to provision or configure the resource | WebPubSubProperties |
ManagedIdentity
Name | Description | Value |
---|---|---|
type | Represent the identity type: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Get or set the user assigned identities | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
Name | Description | Value |
---|---|---|
{customized property} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
eventHandler | The settings for event handler in webpubsub service. | EventHandlerSettings |
liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
networkACLs | Network ACLs | 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 |
tls | TLS settings. | WebPubSubTlsSettings |
EventHandlerSettings
Name | Description | Value |
---|---|---|
items | Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate. | EventHandlerSettingsItems |
EventHandlerSettingsItems
Name | Description | Value |
---|---|---|
{customized property} | EventHandlerTemplate[] |
EventHandlerTemplate
Name | Description | Value |
---|---|---|
auth | Gets or sets the auth settings for an event handler. If not set, no auth is used. | UpstreamAuthSettings |
systemEventPattern | Gets ot sets the system event pattern. There are 2 kind of patterns supported: 1. The single event name, for example, "connect", it matches "connect" 2. Combine multiple events with ",", for example "connect,disconnected", it matches event "connect" and "disconnected" |
string |
urlTemplate | Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event} . The host part can't contains parameters. |
string (required) |
userEventPattern | Gets or sets the matching pattern for event names. There are 3 kind of patterns supported: 1. "*", it to matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" |
string |
UpstreamAuthSettings
Name | Description | Value |
---|---|---|
managedIdentity | Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity. | ManagedIdentitySettings |
type | Gets or sets the type of auth. None or ManagedIdentity is supported now. | 'ManagedIdentity' 'None' |
ManagedIdentitySettings
Name | Description | Value |
---|---|---|
resource | The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. |
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 |
LiveTraceCategory
Name | Description | Value |
---|---|---|
enabled | Indicates whether or the log category is enabled. Available values: true, false. Case insensitive. |
string |
name | Gets or sets the log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
WebPubSubNetworkACLs
Name | Description | Value |
---|---|---|
defaultAction | Default action when no other rule matches | 'Allow' 'Deny' |
privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
publicNetwork | ACL for requests from public network | NetworkACL |
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) |
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' |
WebPubSubTlsSettings
Name | Description | Value |
---|---|---|
clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |
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,5,10,20,50,100 |
int |
name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 |
string (required) |
tier | Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead. |
'Basic' 'Free' 'Premium' 'Standard' |
Quickstart templates
The following 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. |
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": "2021-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"eventHandler": {
"items": {
"{customized property}": [
{
"auth": {
"managedIdentity": {
"resource": "string"
},
"type": "string"
},
"systemEventPattern": "string",
"urlTemplate": "string",
"userEventPattern": "string"
}
]
}
},
"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",
"tls": {
"clientCertEnabled": "bool"
}
}
}
Property values
webPubSub
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.SignalRService/webPubSub' |
apiVersion | The resource api version | '2021-09-01-preview' |
name | The resource name | string (required) |
location | The GEO location of the resource. e.g. West US , East US , North Central US , South Central US. | string |
tags | Tags of the service which is 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. Free, Standard) | ResourceSku |
identity | The managed identity response | ManagedIdentity |
properties | Settings used to provision or configure the resource | WebPubSubProperties |
ManagedIdentity
Name | Description | Value |
---|---|---|
type | Represent the identity type: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Get or set the user assigned identities | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
Name | Description | Value |
---|---|---|
{customized property} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
eventHandler | The settings for event handler in webpubsub service. | EventHandlerSettings |
liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
networkACLs | Network ACLs | 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 |
tls | TLS settings. | WebPubSubTlsSettings |
EventHandlerSettings
Name | Description | Value |
---|---|---|
items | Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate. | EventHandlerSettingsItems |
EventHandlerSettingsItems
Name | Description | Value |
---|---|---|
{customized property} | EventHandlerTemplate[] |
EventHandlerTemplate
Name | Description | Value |
---|---|---|
auth | Gets or sets the auth settings for an event handler. If not set, no auth is used. | UpstreamAuthSettings |
systemEventPattern | Gets ot sets the system event pattern. There are 2 kind of patterns supported: 1. The single event name, for example, "connect", it matches "connect" 2. Combine multiple events with ",", for example "connect,disconnected", it matches event "connect" and "disconnected" |
string |
urlTemplate | Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event} . The host part can't contains parameters. |
string (required) |
userEventPattern | Gets or sets the matching pattern for event names. There are 3 kind of patterns supported: 1. "*", it to matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" |
string |
UpstreamAuthSettings
Name | Description | Value |
---|---|---|
managedIdentity | Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity. | ManagedIdentitySettings |
type | Gets or sets the type of auth. None or ManagedIdentity is supported now. | 'ManagedIdentity' 'None' |
ManagedIdentitySettings
Name | Description | Value |
---|---|---|
resource | The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. |
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 |
LiveTraceCategory
Name | Description | Value |
---|---|---|
enabled | Indicates whether or the log category is enabled. Available values: true, false. Case insensitive. |
string |
name | Gets or sets the log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
WebPubSubNetworkACLs
Name | Description | Value |
---|---|---|
defaultAction | Default action when no other rule matches | 'Allow' 'Deny' |
privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
publicNetwork | ACL for requests from public network | NetworkACL |
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) |
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' |
WebPubSubTlsSettings
Name | Description | Value |
---|---|---|
clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |
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,5,10,20,50,100 |
int |
name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 |
string (required) |
tier | Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead. |
'Basic' 'Free' 'Premium' 'Standard' |
Quickstart templates
The following 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@2021-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
disableAadAuth = bool
disableLocalAuth = bool
eventHandler = {
items = {
{customized property} = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
systemEventPattern = "string"
urlTemplate = "string"
userEventPattern = "string"
}
]
}
}
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"
tls = {
clientCertEnabled = bool
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Property values
webPubSub
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.SignalRService/webPubSub@2021-09-01-preview" |
name | The resource name | string (required) |
location | The GEO location of the resource. e.g. West US , East US , North Central US , South Central US. | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Tags of the service which is 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. Free, Standard) | ResourceSku |
identity | The managed identity response | ManagedIdentity |
properties | Settings used to provision or configure the resource | WebPubSubProperties |
ManagedIdentity
Name | Description | Value |
---|---|---|
type | Represent the identity type: systemAssigned, userAssigned, None | "SystemAssigned" "UserAssigned" |
identity_ids | Get or set the user assigned identities | Array of user identity IDs. |
ManagedIdentityUserAssignedIdentities
Name | Description | Value |
---|---|---|
{customized property} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
eventHandler | The settings for event handler in webpubsub service. | EventHandlerSettings |
liveTraceConfiguration | Live trace configuration of a Microsoft.SignalRService resource. | LiveTraceConfiguration |
networkACLs | Network ACLs | 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 |
tls | TLS settings. | WebPubSubTlsSettings |
EventHandlerSettings
Name | Description | Value |
---|---|---|
items | Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate. | EventHandlerSettingsItems |
EventHandlerSettingsItems
Name | Description | Value |
---|---|---|
{customized property} | EventHandlerTemplate[] |
EventHandlerTemplate
Name | Description | Value |
---|---|---|
auth | Gets or sets the auth settings for an event handler. If not set, no auth is used. | UpstreamAuthSettings |
systemEventPattern | Gets ot sets the system event pattern. There are 2 kind of patterns supported: 1. The single event name, for example, "connect", it matches "connect" 2. Combine multiple events with ",", for example "connect,disconnected", it matches event "connect" and "disconnected" |
string |
urlTemplate | Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event} . The host part can't contains parameters. |
string (required) |
userEventPattern | Gets or sets the matching pattern for event names. There are 3 kind of patterns supported: 1. "*", it to matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" |
string |
UpstreamAuthSettings
Name | Description | Value |
---|---|---|
managedIdentity | Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity. | ManagedIdentitySettings |
type | Gets or sets the type of auth. None or ManagedIdentity is supported now. | "ManagedIdentity" "None" |
ManagedIdentitySettings
Name | Description | Value |
---|---|---|
resource | The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. |
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 |
LiveTraceCategory
Name | Description | Value |
---|---|---|
enabled | Indicates whether or the log category is enabled. Available values: true, false. Case insensitive. |
string |
name | Gets or sets the log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
string |
WebPubSubNetworkACLs
Name | Description | Value |
---|---|---|
defaultAction | Default action when no other rule matches | "Allow" "Deny" |
privateEndpoints | ACLs for requests from private endpoints | PrivateEndpointACL[] |
publicNetwork | ACL for requests from public network | NetworkACL |
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) |
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" |
WebPubSubTlsSettings
Name | Description | Value |
---|---|---|
clientCertEnabled | Request client certificate during TLS handshake if enabled | bool |
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,5,10,20,50,100 |
int |
name | The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 |
string (required) |
tier | Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead. |
"Basic" "Free" "Premium" "Standard" |