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=2021-09-01-preview

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName
path True
  • string

The name of the resource.

subscriptionId
path True
  • string

Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Request Body

Name Type Description
identity

The managed identity response

kind

The kind of the service - e.g. "SignalR" for "Microsoft.SignalRService/SignalR"

location
  • string

The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.

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.networkACLs

Network ACLs

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.tls

TLS settings.

properties.upstream

Upstream settings when the service is in server-less mode.

sku

The billing information of the resource.(e.g. Free, Standard)

tags
  • object

Tags of the service which is a list of key value pairs that describe the resource.

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=2021-09-01-preview
{
  "sku": {
    "name": "Standard_S1",
    "tier": "Standard",
    "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": {}
      }
    ],
    "cors": {
      "allowedOrigins": [
        "https://foo.com",
        "https://bar.com"
      ]
    },
    "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": "Standard_S1",
    "tier": "Standard",
    "size": "S1",
    "capacity": 1
  },
  "properties": {
    "provisioningState": "Succeeded",
    "externalIP": "10.0.0.1",
    "hostName": "mysignalrservice.service.signalr.net",
    "publicPort": 443,
    "serverPort": 443,
    "version": "1.0",
    "privateEndpointConnections": [
      {
        "systemData": {
          "createdBy": "string",
          "createdByType": "User",
          "createdAt": "2015-02-03T04:05:06Z",
          "lastModifiedBy": "string",
          "lastModifiedByType": "User",
          "lastModifiedAt": "2015-02-03T04:05:06Z"
        },
        "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"
      }
    ],
    "tls": {
      "clientCertEnabled": true
    },
    "features": [
      {
        "flag": "ServiceMode",
        "value": "Serverless",
        "properties": {}
      },
      {
        "flag": "EnableConnectivityLogs",
        "value": "True",
        "properties": {}
      },
      {
        "flag": "EnableMessagingLogs",
        "value": "False",
        "properties": {}
      },
      {
        "flag": "EnableLiveTrace",
        "value": "False",
        "properties": {}
      }
    ],
    "cors": {
      "allowedOrigins": [
        "https://foo.com",
        "https://bar.com"
      ]
    },
    "upstream": {
      "templates": [
        {
          "urlTemplate": "http://foo.com"
        }
      ]
    },
    "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",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2015-02-03T04:05:06Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2015-02-03T04:05:06Z"
  },
  "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"
}
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": "Standard_S1",
    "tier": "Standard",
    "size": "S1",
    "capacity": 1
  },
  "properties": {
    "provisioningState": "Succeeded",
    "externalIP": "10.0.0.1",
    "hostName": "mysignalrservice.service.signalr.net",
    "publicPort": 443,
    "serverPort": 443,
    "version": "1.0",
    "privateEndpointConnections": [
      {
        "systemData": {
          "createdBy": "string",
          "createdByType": "User",
          "createdAt": "2015-02-03T04:05:06Z",
          "lastModifiedBy": "string",
          "lastModifiedByType": "User",
          "lastModifiedAt": "2015-02-03T04:05:06Z"
        },
        "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"
      }
    ],
    "tls": {
      "clientCertEnabled": true
    },
    "features": [
      {
        "flag": "ServiceMode",
        "value": "Serverless",
        "properties": {}
      },
      {
        "flag": "EnableConnectivityLogs",
        "value": "True",
        "properties": {}
      },
      {
        "flag": "EnableMessagingLogs",
        "value": "False",
        "properties": {}
      },
      {
        "flag": "EnableLiveTrace",
        "value": "False",
        "properties": {}
      }
    ],
    "cors": {
      "allowedOrigins": [
        "https://foo.com",
        "https://bar.com"
      ]
    },
    "upstream": {
      "templates": [
        {
          "urlTemplate": "http://foo.com"
        }
      ]
    },
    "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",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2015-02-03T04:05:06Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2015-02-03T04:05:06Z"
  },
  "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"
}
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...

Definitions

ACLAction

Default action when no other rule matches

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

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.
ManagedIdentity

A class represent managed identities used for request and response

ManagedIdentitySettings

Managed identity settings for upstream.

ManagedIdentityType

Represent the identity type: systemAssigned, userAssigned, None

NetworkACL

Network ACL

PrivateEndpoint

Private endpoint

PrivateEndpointACL

ACL for a private endpoint

PrivateEndpointConnection

A private endpoint connection to an azure resource

PrivateLinkServiceConnectionState

Connection state of the private endpoint connection

PrivateLinkServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

Provisioning state of the resource.

ResourceSku

The billing information of the resource.

ServerlessUpstreamSettings

The settings for the Upstream when the service is in server-less mode.

ServiceKind

The kind of the service - e.g. "SignalR" for "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResource

Describes a Shared Private Link Resource

SharedPrivateLinkResourceStatus

Status of the shared private link resource

SignalRCorsSettings

Cross-Origin Resource Sharing (CORS) settings.

SignalRFeature

Feature of a resource, which controls the runtime behavior.

SignalRNetworkACLs

Network ACLs for the resource

SignalRResource

A class represent a resource.

SignalRSkuTier

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

SignalRTlsSettings

TLS settings for the resource

systemData

Metadata pertaining to creation and last modification of the resource.

UpstreamAuthSettings

Upstream auth settings.

UpstreamAuthType

Gets or sets the type of auth. None or ManagedIdentity is supported now.

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.

UserAssignedIdentityProperty

Properties of user assigned identity.

ACLAction

Default action when no other rule matches

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

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

Represent the identity type: systemAssigned, userAssigned, None

userAssignedIdentities

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

Represent the identity type: systemAssigned, userAssigned, None

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

NetworkACL

Network ACL

Name Type Description
allow
  • string[]

Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

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
  • string[]

Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

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.

name
  • string

The name of the resource.

properties.privateEndpoint

Private endpoint associated with the private endpoint connection

properties.privateLinkServiceConnectionState

Connection state

properties.provisioningState

Provisioning state of the private endpoint connection

systemData

Metadata pertaining to creation and last modification of the resource.

type
  • string

The type of the resource - e.g. "Microsoft.SignalRService/SignalR"

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

ResourceSku

The billing information of the resource.

Name Type Description
capacity
  • integer

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

family
  • string

Not used. Retained for future use.

name
  • string

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1

size
  • string

Not used. Retained for future use.

tier

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

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 - e.g. "SignalR" for "Microsoft.SignalRService/SignalR"

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.

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 shared private link 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

Metadata pertaining to creation and last modification of the resource.

type
  • string

The type of the resource - e.g. "Microsoft.SignalRService/SignalR"

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.

  • 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.
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

Default action when no other rule matches

privateEndpoints

ACLs for requests from private endpoints

publicNetwork

ACL for requests from public network

SignalRResource

A class represent a resource.

Name Type Description
id
  • string

Fully qualified resource Id for the resource.

identity

The managed identity response

kind

The kind of the service - e.g. "SignalR" for "Microsoft.SignalRService/SignalR"

location
  • string

The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.

name
  • string

The name of the resource.

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.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.networkACLs

Network ACLs

properties.privateEndpointConnections

Private endpoint connections to the resource.

properties.provisioningState

Provisioning state of 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.publicPort
  • integer

The publicly accessible port of the resource which is designed for browser/client side usage.

properties.serverPort
  • integer

The publicly accessible port of the resource which is designed for customer server side usage.

properties.sharedPrivateLinkResources

The list of shared private link resources.

properties.tls

TLS settings.

properties.upstream

Upstream settings 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.(e.g. Free, Standard)

systemData

Metadata pertaining to creation and last modification of the resource.

tags
  • object

Tags of the service which is a list of key value pairs that describe the resource.

type
  • string

The type of the resource - e.g. "Microsoft.SignalRService/SignalR"

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 Description
clientCertEnabled
  • boolean

Request client certificate during TLS handshake if enabled

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.

Name Type Description
managedIdentity

Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity.

type

Gets or sets the type of auth. None or ManagedIdentity is supported now.

UpstreamAuthType

Gets or sets the type of auth. None or ManagedIdentity is supported now.

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

Gets or sets the auth settings for an upstream. 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 http://example.com/{hub}/api/{event}, with a client request from hub chat connects, it will first POST to this URL: http://example.com/chat/api/connect.

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