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

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

Success. The response describes SignalR service access keys.

Other Status Codes

An unexpected error occurred during the operation.

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

ErrorResponse

Contains information about an API error.

ErrorResponseBody

Describes a particular API error with an error code and a message.

SignalRKeys

A class represents the access keys of SignalR service.

ErrorResponse

Contains information about an API error.

Name Type Description
error

Describes a particular API error with an error code and a message.

ErrorResponseBody

Describes a particular API error with an error code and a message.

Name Type Description
code
  • string

An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

details

Contains nested errors that are related to this error.

message
  • string

A message that describes the error in detail and provides debugging information.

target
  • string

The target of the particular error (for example, the name of the property in error).

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.