SignalR - List Keys

Get the access keys of the SignalR resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys?api-version=2018-10-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.

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 SignalR resource.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Success. The response describes SignalR service access keys.

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_ListKeys

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/listKeys?api-version=2018-10-01

Sample Response

{
  "primaryKey": "primaryAccessKey",
  "secondaryKey": "secondaryAccessKey",
  "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0",
  "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0"
}

Definitions

SignalRKeys

A class represents the access keys of SignalR service.

Name Type Description
primaryConnectionString
  • string

SignalR connection string constructed via the primaryKey

primaryKey
  • string

The primary access key.

secondaryConnectionString
  • string

SignalR connection string constructed via the secondaryKey

secondaryKey
  • string

The secondary access key.