SignalR - Create Or Update
Create or update a resource.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}?api-version=2024-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
resource
|
path | True |
string |
The name of the resource. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
location | True |
string |
The geo-location where the resource lives |
identity |
A class represent managed identities used for request and response |
||
kind |
The kind of the service |
||
properties.cors |
Cross-Origin Resource Sharing (CORS) settings. |
||
properties.disableAadAuth |
boolean |
DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. |
|
properties.disableLocalAuth |
boolean |
DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. |
|
properties.features |
List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. |
||
properties.liveTraceConfiguration |
Live trace configuration of a Microsoft.SignalRService resource. |
||
properties.networkACLs |
Network ACLs for the resource |
||
properties.publicNetworkAccess |
string |
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. |
|
properties.regionEndpointEnabled |
string |
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. This property is replica specific. Disable the regional endpoint without replica is not allowed. |
|
properties.resourceLogConfiguration |
Resource log configuration of a Microsoft.SignalRService resource. |
||
properties.resourceStopped |
string |
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. |
|
properties.serverless |
Serverless settings. |
||
properties.tls |
TLS settings for the resource |
||
properties.upstream |
The settings for the Upstream when the service is in server-less mode. |
||
sku |
The billing information of the resource. |
||
tags |
object |
Resource tags. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The response describes a resource. |
|
201 Created |
Created. The response describes the new resource and contains a Location header to query the operation result. |
|
202 Accepted |
Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
SignalR_CreateOrUpdate
Sample Request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/signalR/mySignalRService?api-version=2024-03-01
{
"sku": {
"name": "Premium_P1",
"tier": "Premium",
"capacity": 1
},
"properties": {
"tls": {
"clientCertEnabled": false
},
"features": [
{
"flag": "ServiceMode",
"value": "Serverless",
"properties": {}
},
{
"flag": "EnableConnectivityLogs",
"value": "True",
"properties": {}
},
{
"flag": "EnableMessagingLogs",
"value": "False",
"properties": {}
},
{
"flag": "EnableLiveTrace",
"value": "False",
"properties": {}
}
],
"liveTraceConfiguration": {
"enabled": "false",
"categories": [
{
"name": "ConnectivityLogs",
"enabled": "true"
}
]
},
"cors": {
"allowedOrigins": [
"https://foo.com",
"https://bar.com"
]
},
"serverless": {
"connectionTimeoutInSeconds": 5
},
"upstream": {
"templates": [
{
"hubPattern": "*",
"eventPattern": "connect,disconnect",
"categoryPattern": "*",
"urlTemplate": "https://example.com/chat/api/connect",
"auth": {
"type": "ManagedIdentity",
"managedIdentity": {
"resource": "api://example"
}
}
}
]
},
"networkACLs": {
"defaultAction": "Deny",
"publicNetwork": {
"allow": [
"ClientConnection"
]
},
"privateEndpoints": [
{
"name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"allow": [
"ServerConnection"
]
}
]
},
"publicNetworkAccess": "Enabled",
"disableLocalAuth": false,
"disableAadAuth": false
},
"kind": "SignalR",
"identity": {
"type": "SystemAssigned"
},
"location": "eastus",
"tags": {
"key1": "value1"
}
}
Sample Response
{
"sku": {
"name": "Premium_P1",
"tier": "Premium",
"size": "P1",
"capacity": 1
},
"properties": {
"provisioningState": "Succeeded",
"externalIP": "10.0.0.1",
"hostName": "mysignalrservice.service.signalr.net",
"publicPort": 443,
"serverPort": 443,
"version": "1.0",
"privateEndpointConnections": [
{
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"actionsRequired": "None"
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"type": "Microsoft.SignalRService/SignalR/privateEndpointConnections",
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2015-02-03T04:05:06Z",
"lastModifiedBy": "string",
"lastModifiedByType": "User",
"lastModifiedAt": "2015-02-03T04:05:06Z"
}
}
],
"tls": {
"clientCertEnabled": true
},
"features": [
{
"flag": "ServiceMode",
"value": "Serverless",
"properties": {}
},
{
"flag": "EnableConnectivityLogs",
"value": "True",
"properties": {}
},
{
"flag": "EnableMessagingLogs",
"value": "False",
"properties": {}
},
{
"flag": "EnableLiveTrace",
"value": "False",
"properties": {}
}
],
"liveTraceConfiguration": {
"enabled": "false",
"categories": [
{
"name": "ConnectivityLogs",
"enabled": "true"
}
]
},
"resourceLogConfiguration": {
"categories": [
{
"name": "ConnectivityLogs",
"enabled": "true"
}
]
},
"cors": {
"allowedOrigins": [
"https://foo.com",
"https://bar.com"
]
},
"serverless": {
"connectionTimeoutInSeconds": 5
},
"upstream": {
"templates": [
{
"urlTemplate": "http://foo.com"
}
]
},
"networkACLs": {
"defaultAction": "Deny",
"publicNetwork": {
"allow": [
"ClientConnection"
]
},
"privateEndpoints": [
{
"name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"allow": [
"ServerConnection"
]
}
],
"ipRules": [
{
"value": "123.456.789.123/24",
"action": "Allow"
},
{
"value": "123.456.789.123",
"action": "Allow"
},
{
"value": "AppService",
"action": "Allow"
}
]
},
"publicNetworkAccess": "Enabled",
"disableLocalAuth": false,
"disableAadAuth": false,
"regionEndpointEnabled": "Enabled",
"resourceStopped": "false"
},
"kind": "SignalR",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "eastus",
"tags": {
"key1": "value1"
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
"name": "mySignalRService",
"type": "Microsoft.SignalRService/SignalR",
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2015-02-03T04:05:06Z",
"lastModifiedBy": "string",
"lastModifiedByType": "User",
"lastModifiedAt": "2015-02-03T04:05:06Z"
}
}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...
{
"sku": {
"name": "Premium_P1",
"tier": "Premium",
"size": "P1",
"capacity": 1
},
"properties": {
"provisioningState": "Succeeded",
"externalIP": "10.0.0.1",
"hostName": "mysignalrservice.service.signalr.net",
"publicPort": 443,
"serverPort": 443,
"version": "1.0",
"privateEndpointConnections": [
{
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"actionsRequired": "None"
}
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"type": "Microsoft.SignalRService/SignalR/privateEndpointConnections",
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2015-02-03T04:05:06Z",
"lastModifiedBy": "string",
"lastModifiedByType": "User",
"lastModifiedAt": "2015-02-03T04:05:06Z"
}
}
],
"tls": {
"clientCertEnabled": true
},
"features": [
{
"flag": "ServiceMode",
"value": "Serverless",
"properties": {}
},
{
"flag": "EnableConnectivityLogs",
"value": "True",
"properties": {}
},
{
"flag": "EnableMessagingLogs",
"value": "False",
"properties": {}
},
{
"flag": "EnableLiveTrace",
"value": "False",
"properties": {}
}
],
"liveTraceConfiguration": {
"enabled": "false",
"categories": [
{
"name": "ConnectivityLogs",
"enabled": "true"
}
]
},
"resourceLogConfiguration": {
"categories": [
{
"name": "ConnectivityLogs",
"enabled": "true"
}
]
},
"cors": {
"allowedOrigins": [
"https://foo.com",
"https://bar.com"
]
},
"serverless": {
"connectionTimeoutInSeconds": 5
},
"upstream": {
"templates": [
{
"urlTemplate": "http://foo.com"
}
]
},
"networkACLs": {
"defaultAction": "Deny",
"publicNetwork": {
"allow": [
"ClientConnection"
]
},
"privateEndpoints": [
{
"name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
"allow": [
"ServerConnection"
]
}
],
"ipRules": [
{
"value": "123.456.789.123/24",
"action": "Allow"
},
{
"value": "123.456.789.123",
"action": "Allow"
},
{
"value": "AppService",
"action": "Allow"
}
]
},
"publicNetworkAccess": "Enabled",
"disableLocalAuth": false,
"disableAadAuth": false,
"regionEndpointEnabled": "Enabled",
"resourceStopped": "false"
},
"kind": "SignalR",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "eastus",
"tags": {
"key1": "value1"
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
"name": "mySignalRService",
"type": "Microsoft.SignalRService/SignalR",
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2015-02-03T04:05:06Z",
"lastModifiedBy": "string",
"lastModifiedByType": "User",
"lastModifiedAt": "2015-02-03T04:05:06Z"
}
}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...
Definitions
Name | Description |
---|---|
ACLAction |
Azure Networking ACL Action. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Feature |
FeatureFlags is the supported features of Azure SignalR service.
|
IPRule |
An IP rule |
Live |
Live trace category configuration of a Microsoft.SignalRService resource. |
Live |
Live trace configuration of a Microsoft.SignalRService resource. |
Managed |
A class represent managed identities used for request and response |
Managed |
Managed identity settings for upstream. |
Managed |
Represents the identity type: systemAssigned, userAssigned, None |
NetworkACL |
Network ACL |
Private |
Private endpoint |
Private |
ACL for a private endpoint |
Private |
A private endpoint connection to an azure resource |
Private |
Connection state of the private endpoint connection |
Private |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
Provisioning |
Provisioning state of the resource. |
Resource |
Resource log category configuration of a Microsoft.SignalRService resource. |
Resource |
Resource log configuration of a Microsoft.SignalRService resource. |
Resource |
The billing information of the resource. |
Serverless |
Serverless settings. |
Serverless |
The settings for the Upstream when the service is in server-less mode. |
Service |
The kind of the service |
Shared |
Describes a Shared Private Link Resource |
Shared |
Status of the shared private link resource |
Signal |
Cross-Origin Resource Sharing (CORS) settings. |
Signal |
Feature of a resource, which controls the runtime behavior. |
Signal |
Network ACLs for the resource |
Signal |
The incoming request type to the service |
Signal |
A class represent a resource. |
Signal |
Optional tier of this particular SKU. 'Standard' or 'Free'.
|
Signal |
TLS settings for the resource |
system |
Metadata pertaining to creation and last modification of the resource. |
Upstream |
Upstream auth settings. If not set, no auth is used for upstream messages. |
Upstream |
Upstream auth type enum. |
Upstream |
Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template. |
User |
Properties of user assigned identity. |
ACLAction
Azure Networking ACL Action.
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
FeatureFlags
FeatureFlags is the supported features of Azure SignalR service.
- ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use.
- EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively.
- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively.
- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature.
Name | Type | Description |
---|---|---|
EnableConnectivityLogs |
string |
|
EnableLiveTrace |
string |
|
EnableMessagingLogs |
string |
|
ServiceMode |
string |
IPRule
An IP rule
Name | Type | Description |
---|---|---|
action |
Azure Networking ACL Action. |
|
value |
string |
An IP or CIDR or ServiceTag |
LiveTraceCategory
Live trace category configuration of a Microsoft.SignalRService resource.
Name | Type | Description |
---|---|---|
enabled |
string |
Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. |
name |
string |
Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
LiveTraceConfiguration
Live trace configuration of a Microsoft.SignalRService resource.
Name | Type | Default Value | Description |
---|---|---|---|
categories |
Gets or sets the list of category configurations. |
||
enabled |
string |
false |
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. |
ManagedIdentity
A class represent managed identities used for request and response
Name | Type | Description |
---|---|---|
principalId |
string |
Get the principal id for the system assigned identity. Only be used in response. |
tenantId |
string |
Get the tenant id for the system assigned identity. Only be used in response |
type |
Represents the identity type: systemAssigned, userAssigned, None |
|
userAssignedIdentities |
<string,
User |
Get or set the user assigned identities |
ManagedIdentitySettings
Managed identity settings for upstream.
Name | Type | Description |
---|---|---|
resource |
string |
The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. |
ManagedIdentityType
Represents the identity type: systemAssigned, userAssigned, None
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
NetworkACL
Network ACL
Name | Type | Description |
---|---|---|
allow |
Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. |
|
deny |
Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. |
PrivateEndpoint
Private endpoint
Name | Type | Description |
---|---|---|
id |
string |
Full qualified Id of the private endpoint |
PrivateEndpointACL
ACL for a private endpoint
Name | Type | Description |
---|---|---|
allow |
Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. |
|
deny |
Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. |
|
name |
string |
Name of the private endpoint connection |
PrivateEndpointConnection
A private endpoint connection to an azure resource
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties.groupIds |
string[] |
Group IDs |
properties.privateEndpoint |
Private endpoint |
|
properties.privateLinkServiceConnectionState |
Connection state of the private endpoint connection |
|
properties.provisioningState |
Provisioning state of the resource. |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateLinkServiceConnectionState
Connection state of the private endpoint connection
Name | Type | Description |
---|---|---|
actionsRequired |
string |
A message indicating if changes on the service provider require any updates on the consumer. |
description |
string |
The reason for approval/rejection of the connection. |
status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
PrivateLinkServiceConnectionStatus
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
ProvisioningState
Provisioning state of the resource.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
Running |
string |
|
Succeeded |
string |
|
Unknown |
string |
|
Updating |
string |
ResourceLogCategory
Resource log category configuration of a Microsoft.SignalRService resource.
Name | Type | Description |
---|---|---|
enabled |
string |
Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. |
name |
string |
Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. |
ResourceLogConfiguration
Resource log configuration of a Microsoft.SignalRService resource.
Name | Type | Description |
---|---|---|
categories |
Gets or sets the list of category configurations. |
ResourceSku
The billing information of the resource.
Name | Type | Description |
---|---|---|
capacity |
integer |
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; |
family |
string |
Not used. Retained for future use. |
name |
string |
The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
size |
string |
Not used. Retained for future use. |
tier |
Optional tier of this particular SKU. 'Standard' or 'Free'.
|
ServerlessSettings
Serverless settings.
Name | Type | Default Value | Description |
---|---|---|---|
connectionTimeoutInSeconds |
integer |
30 |
Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. |
ServerlessUpstreamSettings
The settings for the Upstream when the service is in server-less mode.
Name | Type | Description |
---|---|---|
templates |
Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. |
ServiceKind
The kind of the service
Name | Type | Description |
---|---|---|
RawWebSockets |
string |
|
SignalR |
string |
SharedPrivateLinkResource
Describes a Shared Private Link Resource
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties.groupId |
string |
The group id from the provider of resource the shared private link resource is for |
properties.privateLinkResourceId |
string |
The resource id of the resource the shared private link resource is for |
properties.provisioningState |
Provisioning state of the resource. |
|
properties.requestMessage |
string |
The request message for requesting approval of the shared private link resource |
properties.status |
Status of the shared private link resource |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
SharedPrivateLinkResourceStatus
Status of the shared private link resource
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
|
Timeout |
string |
SignalRCorsSettings
Cross-Origin Resource Sharing (CORS) settings.
Name | Type | Description |
---|---|---|
allowedOrigins |
string[] |
Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. |
SignalRFeature
Feature of a resource, which controls the runtime behavior.
Name | Type | Description |
---|---|---|
flag |
FeatureFlags is the supported features of Azure SignalR service.
|
|
properties |
object |
Optional properties related to this feature. |
value |
string |
Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. |
SignalRNetworkACLs
Network ACLs for the resource
Name | Type | Description |
---|---|---|
defaultAction |
Azure Networking ACL Action. |
|
ipRules |
IPRule[] |
IP rules for filtering public traffic |
privateEndpoints |
ACLs for requests from private endpoints |
|
publicNetwork |
Network ACL |
SignalRRequestType
The incoming request type to the service
Name | Type | Description |
---|---|---|
ClientConnection |
string |
|
RESTAPI |
string |
|
ServerConnection |
string |
|
Trace |
string |
SignalRResource
A class represent a resource.
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
identity |
A class represent managed identities used for request and response |
||
kind |
The kind of the service |
||
location |
string |
The geo-location where the resource lives |
|
name |
string |
The name of the resource |
|
properties.cors |
Cross-Origin Resource Sharing (CORS) settings. |
||
properties.disableAadAuth |
boolean |
False |
DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. |
properties.disableLocalAuth |
boolean |
False |
DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. |
properties.externalIP |
string |
The publicly accessible IP of the resource. |
|
properties.features |
List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. |
||
properties.hostName |
string |
FQDN of the service instance. |
|
properties.hostNamePrefix |
string |
Deprecated. |
|
properties.liveTraceConfiguration |
Live trace configuration of a Microsoft.SignalRService resource. |
||
properties.networkACLs |
Network ACLs for the resource |
||
properties.privateEndpointConnections |
Private endpoint connections to the resource. |
||
properties.provisioningState |
Provisioning state of the resource. |
||
properties.publicNetworkAccess |
string |
Enabled |
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. |
properties.publicPort |
integer |
The publicly accessible port of the resource which is designed for browser/client side usage. |
|
properties.regionEndpointEnabled |
string |
Enabled |
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. This property is replica specific. Disable the regional endpoint without replica is not allowed. |
properties.resourceLogConfiguration |
Resource log configuration of a Microsoft.SignalRService resource. |
||
properties.resourceStopped |
string |
false |
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. |
properties.serverPort |
integer |
The publicly accessible port of the resource which is designed for customer server side usage. |
|
properties.serverless |
Serverless settings. |
||
properties.sharedPrivateLinkResources |
The list of shared private link resources. |
||
properties.tls |
TLS settings for the resource |
||
properties.upstream |
The settings for the Upstream when the service is in server-less mode. |
||
properties.version |
string |
Version of the resource. Probably you need the same or higher version of client SDKs. |
|
sku |
The billing information of the resource. |
||
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
||
tags |
object |
Resource tags. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
SignalRSkuTier
Optional tier of this particular SKU. 'Standard' or 'Free'.
Basic
is deprecated, use Standard
instead.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
SignalRTlsSettings
TLS settings for the resource
Name | Type | Default Value | Description |
---|---|---|---|
clientCertEnabled |
boolean |
False |
Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
UpstreamAuthSettings
Upstream auth settings. If not set, no auth is used for upstream messages.
Name | Type | Description |
---|---|---|
managedIdentity |
Managed identity settings for upstream. |
|
type |
Upstream auth type enum. |
UpstreamAuthType
Upstream auth type enum.
Name | Type | Description |
---|---|---|
ManagedIdentity |
string |
|
None |
string |
UpstreamTemplate
Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.
Name | Type | Description |
---|---|---|
auth |
Upstream auth settings. If not set, no auth is used for upstream messages. |
|
categoryPattern |
string |
Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". |
eventPattern |
string |
Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". |
hubPattern |
string |
Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". |
urlTemplate |
string |
Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.
For example, if the urlTemplate is |
UserAssignedIdentityProperty
Properties of user assigned identity.
Name | Type | Description |
---|---|---|
clientId |
string |
Get the client id for the user assigned identity |
principalId |
string |
Get the principal id for the user assigned identity |