SignalR - List By Subscription

Reference

Service:: SignalR Service

API Version:: 2023-02-01

Handles requests to list all resources in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR?api-version=2023-02-01

URI Parameters

Name	In	Required	Type	Description
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.

Responses

Name	Type	Description
200 OK	SignalRResourceList	Success. The response describes the list of resources in the subscription.
Other Status Codes	ErrorResponse	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_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/signalR?api-version=2023-02-01

/** Samples for SignalR List. */
public final class Main {
    /*
     * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListBySubscription.json
     */
    /**
     * Sample code: SignalR_ListBySubscription.
     *
     * @param manager Entry point to SignalRManager.
     */
    public static void signalRListBySubscription(com.azure.resourcemanager.signalr.SignalRManager manager) {
        manager.signalRs().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.signalr import SignalRManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-signalr
# USAGE
    python signal_r_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SignalRManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.signal_r.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsignalr_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/signalr/armsignalr"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListBySubscription.json
func ExampleClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsignalr.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceInfoList = armsignalr.ResourceInfoList{
		// 	Value: []*armsignalr.ResourceInfo{
		// 		{
		// 			Name: to.Ptr("mySignalRService"),
		// 			Type: to.Ptr("Microsoft.SignalRService/SignalR"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"),
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Identity: &armsignalr.ManagedIdentity{
		// 				Type: to.Ptr(armsignalr.ManagedIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 			Kind: to.Ptr(armsignalr.ServiceKindSignalR),
		// 			Properties: &armsignalr.Properties{
		// 				Cors: &armsignalr.CorsSettings{
		// 					AllowedOrigins: []*string{
		// 						to.Ptr("https://foo.com"),
		// 						to.Ptr("https://bar.com")},
		// 					},
		// 					DisableAADAuth: to.Ptr(false),
		// 					DisableLocalAuth: to.Ptr(false),
		// 					ExternalIP: to.Ptr("10.0.0.1"),
		// 					Features: []*armsignalr.Feature{
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsServiceMode),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("Serverless"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableConnectivityLogs),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("True"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableMessagingLogs),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("False"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableLiveTrace),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("False"),
		// 					}},
		// 					HostName: to.Ptr("mysignalrservice.service.signalr.net"),
		// 					LiveTraceConfiguration: &armsignalr.LiveTraceConfiguration{
		// 						Categories: []*armsignalr.LiveTraceCategory{
		// 							{
		// 								Name: to.Ptr("ConnectivityLogs"),
		// 								Enabled: to.Ptr("true"),
		// 						}},
		// 						Enabled: to.Ptr("false"),
		// 					},
		// 					NetworkACLs: &armsignalr.NetworkACLs{
		// 						DefaultAction: to.Ptr(armsignalr.ACLActionDeny),
		// 						PrivateEndpoints: []*armsignalr.PrivateEndpointACL{
		// 							{
		// 								Allow: []*armsignalr.SignalRRequestType{
		// 									to.Ptr(armsignalr.SignalRRequestTypeServerConnection)},
		// 									Name: to.Ptr("mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 							}},
		// 							PublicNetwork: &armsignalr.NetworkACL{
		// 								Allow: []*armsignalr.SignalRRequestType{
		// 									to.Ptr(armsignalr.SignalRRequestTypeClientConnection)},
		// 								},
		// 							},
		// 							PrivateEndpointConnections: []*armsignalr.PrivateEndpointConnection{
		// 								{
		// 									Name: to.Ptr("mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 									Type: to.Ptr("Microsoft.SignalRService/SignalR/privateEndpointConnections"),
		// 									ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 									Properties: &armsignalr.PrivateEndpointConnectionProperties{
		// 										PrivateEndpoint: &armsignalr.PrivateEndpoint{
		// 											ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
		// 										},
		// 										PrivateLinkServiceConnectionState: &armsignalr.PrivateLinkServiceConnectionState{
		// 											ActionsRequired: to.Ptr("None"),
		// 											Status: to.Ptr(armsignalr.PrivateLinkServiceConnectionStatusApproved),
		// 										},
		// 										ProvisioningState: to.Ptr(armsignalr.ProvisioningStateSucceeded),
		// 									},
		// 									SystemData: &armsignalr.SystemData{
		// 										CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 										CreatedBy: to.Ptr("string"),
		// 										CreatedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 										LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 										LastModifiedBy: to.Ptr("string"),
		// 										LastModifiedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 									},
		// 							}},
		// 							ProvisioningState: to.Ptr(armsignalr.ProvisioningStateSucceeded),
		// 							PublicNetworkAccess: to.Ptr("Enabled"),
		// 							PublicPort: to.Ptr[int32](443),
		// 							ResourceLogConfiguration: &armsignalr.ResourceLogConfiguration{
		// 								Categories: []*armsignalr.ResourceLogCategory{
		// 									{
		// 										Name: to.Ptr("ConnectivityLogs"),
		// 										Enabled: to.Ptr("true"),
		// 								}},
		// 							},
		// 							ServerPort: to.Ptr[int32](443),
		// 							Serverless: &armsignalr.ServerlessSettings{
		// 								ConnectionTimeoutInSeconds: to.Ptr[int32](5),
		// 							},
		// 							TLS: &armsignalr.TLSSettings{
		// 								ClientCertEnabled: to.Ptr(true),
		// 							},
		// 							Upstream: &armsignalr.ServerlessUpstreamSettings{
		// 								Templates: []*armsignalr.UpstreamTemplate{
		// 									{
		// 										URLTemplate: to.Ptr("http://foo.com"),
		// 								}},
		// 							},
		// 							Version: to.Ptr("1.0"),
		// 						},
		// 						SKU: &armsignalr.ResourceSKU{
		// 							Name: to.Ptr("Premium_P1"),
		// 							Capacity: to.Ptr[int32](1),
		// 							Size: to.Ptr("P1"),
		// 							Tier: to.Ptr(armsignalr.SignalRSKUTierPremium),
		// 						},
		// 						SystemData: &armsignalr.SystemData{
		// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 							CreatedBy: to.Ptr("string"),
		// 							CreatedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 							LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 							LastModifiedBy: to.Ptr("string"),
		// 							LastModifiedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 						},
		// 				}},
		// 			}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SignalRManagementClient } = require("@azure/arm-signalr");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Handles requests to list all resources in a subscription.
 *
 * @summary Handles requests to list all resources in a subscription.
 * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListBySubscription.json
 */
async function signalRListBySubscription() {
  const subscriptionId =
    process.env["SIGNALR_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new SignalRManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.signalR.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "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": [
          {
            "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": {}
          }
        ],
        "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"
              ]
            }
          ]
        },
        "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"
    }
  ]
}

Definitions

Name	Description
ACLAction	Azure Networking ACL Action.
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.
LiveTraceCategory	Live trace category configuration of a Microsoft.SignalRService resource.
LiveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
ManagedIdentity	A class represent managed identities used for request and response
ManagedIdentitySettings	Managed identity settings for upstream.
ManagedIdentityType	Represents 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.
ResourceLogCategory	Resource log category configuration of a Microsoft.SignalRService resource.
ResourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.
ResourceSku	The billing information of the resource.
ServerlessSettings	Serverless settings.
ServerlessUpstreamSettings	The settings for the Upstream when the service is in server-less mode.
ServiceKind	The kind of the service, it can be SignalR or RawWebSockets
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
SignalRRequestType	The incoming request type to the service
SignalRResource	A class represent a resource.
SignalRResourceList	Object that includes an array of resources and a possible link for next set.
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. If not set, no auth is used for upstream messages.
UpstreamAuthType	Upstream auth type enum.
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

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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	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

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	LiveTraceCategory[]		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	ManagedIdentityType	Represents the identity type: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	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	SignalRRequestType[]	Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny	SignalRRequestType[]	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	SignalRRequestType[]	Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny	SignalRRequestType[]	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.groupIds	string[]	Group IDs
properties.privateEndpoint	PrivateEndpoint	Private endpoint
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Connection state of the private endpoint connection
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
systemData	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	PrivateLinkServiceConnectionStatus	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	ResourceLogCategory[]	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 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;
family	string	Not used. Retained for future use.
name	string	The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1
size	string	Not used. Retained for future use.
tier	SignalRSkuTier	Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead.

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	UpstreamTemplate[]	Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

ServiceKind

The kind of the service, it can be SignalR or RawWebSockets

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	ProvisioningState	Provisioning state of the resource.
properties.requestMessage	string	The request message for requesting approval of the shared private link resource
properties.status	SharedPrivateLinkResourceStatus	Status of the shared private link resource
systemData	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	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.

Name

Type

Description

flag

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.

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	ACLAction	Azure Networking ACL Action.
privateEndpoints	PrivateEndpointACL[]	ACLs for requests from private endpoints
publicNetwork	NetworkACL	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.
identity	ManagedIdentity		A class represent managed identities used for request and response
kind	ServiceKind		The kind of the service, it can be SignalR or RawWebSockets
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	SignalRCorsSettings		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	SignalRFeature[]		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	LiveTraceConfiguration		Live trace configuration of a Microsoft.SignalRService resource.
properties.networkACLs	SignalRNetworkACLs		Network ACLs for the resource
properties.privateEndpointConnections	PrivateEndpointConnection[]		Private endpoint connections to the resource.
properties.provisioningState	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.resourceLogConfiguration	ResourceLogConfiguration		Resource log configuration of a Microsoft.SignalRService resource.
properties.serverPort	integer		The publicly accessible port of the resource which is designed for customer server side usage.
properties.serverless	ServerlessSettings		Serverless settings.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		The list of shared private link resources.
properties.tls	SignalRTlsSettings		TLS settings for the resource
properties.upstream	ServerlessUpstreamSettings		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	ResourceSku		The billing information of the resource.
systemData	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"

SignalRResourceList

Object that includes an array of resources and a possible link for next set.

Name	Type	Description
nextLink	string	The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use.
value	SignalRResource[]	List of the resources

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	True	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	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	createdByType	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	ManagedIdentitySettings	Managed identity settings for upstream.
type	UpstreamAuthType	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	UpstreamAuthSettings	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 `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

SignalR - List By Subscription

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

SignalR_ListBySubscription

Sample Request

Sample Response

Definitions

ACLAction

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureFlags

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentitySettings

ManagedIdentityType

NetworkACL

PrivateEndpoint

PrivateEndpointACL

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServerlessSettings

ServerlessUpstreamSettings

ServiceKind

SharedPrivateLinkResource

SharedPrivateLinkResourceStatus

SignalRCorsSettings

SignalRFeature

SignalRNetworkACLs

SignalRRequestType

SignalRResource

SignalRResourceList

SignalRSkuTier

SignalRTlsSettings

systemData

UpstreamAuthSettings

UpstreamAuthType

UpstreamTemplate

UserAssignedIdentityProperty

Additional resources