Microsoft.SignalRService (stable:2020-05-01)

2025/09/12 • 16 new, 16 deleted methods

Operations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.SignalRService provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SignalRService/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation with format: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: If the operation is a data action. (for data plane rbac) ,
Required: False ,
}
boolean ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. ,
Required: False ,
}
string ,
properties:
{
Description: Extra properties for the operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The service specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that makes sense for the metric. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted. ,
Required: False ,
}
string ,
category:
{
Description: The name of the metric category that the metric belongs to. A metric can only belong to a single category. ,
Required: False ,
}
string ,
dimensions:
{
Description: The dimensions of the metrics. ,
Required: False ,
}
[
{
name:
{
Description: The public facing name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension. ,
Required: False ,
}
string ,
internalName:
{
Description: Name of the dimension as it appears in MDM. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Specifications of the Logs for Azure Monitoring. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_CheckNameAvailability (new)
Description :  Checks that the SignalR name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability
{
location:
{
Description: the region ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: False ,
}
{
type:
{
Description: The resource type. Should be always "Microsoft.SignalRService/SignalR". ,
Required: True ,
}
string ,
name:
{
Description: The SignalR service name to validate. e.g."my-signalR-name-here" ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of the availability. Required if name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The message of the operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListBySubscription (new)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR services ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListByResourceGroup (new)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR services ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Get (new)
Description :  Get the specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Update (new)
Description :  Update the state of specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource of private endpoint and its properties. ,
Required: False ,
}
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Delete (new)
Description :  Delete the specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateLinkResources_List (new)
Description :  Get the private link resources that need to be created for a SignalR resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of PrivateLinkResource ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a private link resource ,
Required: False ,
}
{
groupId:
{
Description: Group Id of the private link resource ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members of the private link resource ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required private DNS zone names ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListKeys (new)
Description :  Get the access keys of the SignalR resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: SignalR connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SignalR connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_RegenerateKey (new)
Description :  Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey
{
parameters:
{
Description: Parameter that describes the Regenerate Key Operation. ,
Required: False ,
}
{
keyType:
{
Description: The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: SignalR connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SignalR connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Get (new)
Description :  Get the SignalR service and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_CreateOrUpdate (new)
Description :  Create a new SignalR service and update an exiting SignalR service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: False ,
}
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Delete (new)
Description :  Operation to delete a SignalR service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Update (new)
Description :  Operation to update an exiting SignalR service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: False ,
}
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Restart (new)
Description :  Operation to restart a SignalR service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Usages_List (new)
Description :  List usage quotas for Azure SignalR service by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages
{
location:
{
Description: the location like "eastus" ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR usages ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ARM resource id ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value for the usage quota. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted value for the usage quota. If there is no limit, this value will be -1. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Localizable String object containing the name and a localized value. ,
Required: False ,
}
{
value:
{
Description: The identifier of the usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name of the usage. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available REST API operations of the Microsoft.SignalRService provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SignalRService/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation with format: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: If the operation is a data action. (for data plane rbac) ,
Required: False ,
}
boolean ,
display:
{
Description: The object that describes the operation. ,
Required: False ,
}
{
provider:
{
Description: Friendly name of the resource provider ,
Required: False ,
}
string ,
resource:
{
Description: Resource type on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. ,
Required: False ,
}
string ,
properties:
{
Description: Extra properties for the operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The service specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that makes sense for the metric. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted. ,
Required: False ,
}
string ,
category:
{
Description: The name of the metric category that the metric belongs to. A metric can only belong to a single category. ,
Required: False ,
}
string ,
dimensions:
{
Description: The dimensions of the metrics. ,
Required: False ,
}
[
{
name:
{
Description: The public facing name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension. ,
Required: False ,
}
string ,
internalName:
{
Description: Name of the dimension as it appears in MDM. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: A Boolean flag indicating whether this dimension should be included for the shoebox export scenario. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Specifications of the Logs for Azure Monitoring. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_CheckNameAvailability (removed)
Description :  Checks that the SignalR name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability
{
location:
{
Description: the region ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: False ,
}
{
type:
{
Description: The resource type. Should be always "Microsoft.SignalRService/SignalR". ,
Required: True ,
}
string ,
name:
{
Description: The SignalR service name to validate. e.g."my-signalR-name-here" ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of the availability. Required if name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The message of the operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListBySubscription (removed)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR services ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListByResourceGroup (removed)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR services ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Get (removed)
Description :  Get the specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Update (removed)
Description :  Update the state of specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource of private endpoint and its properties. ,
Required: False ,
}
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateEndpointConnections_Delete (removed)
Description :  Delete the specified private endpoint connection associated with a SignalR resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the SignalR resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalRPrivateLinkResources_List (removed)
Description :  Get the private link resources that need to be created for a SignalR resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of PrivateLinkResource ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a private link resource ,
Required: False ,
}
{
groupId:
{
Description: Group Id of the private link resource ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members of the private link resource ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required private DNS zone names ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_ListKeys (removed)
Description :  Get the access keys of the SignalR resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: SignalR connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SignalR connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_RegenerateKey (removed)
Description :  Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey
{
parameters:
{
Description: Parameter that describes the Regenerate Key Operation. ,
Required: False ,
}
{
keyType:
{
Description: The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: SignalR connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SignalR connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Get (removed)
Description :  Get the SignalR service and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_CreateOrUpdate (removed)
Description :  Create a new SignalR service and update an exiting SignalR service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: False ,
}
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Delete (removed)
Description :  Operation to delete a SignalR service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Update (removed)
Description :  Operation to update an exiting SignalR service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: False ,
}
{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource.(e.g. Free, Standard) ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1 ,
Required: True ,
}
string ,
tier:
{
Description: Optional tier of this particular SKU. 'Standard' or 'Free'. `Basic` is deprecated, use `Standard` instead. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
family:
{
Description: Not used. Retained for future use. ,
Required: False ,
}
string ,
capacity:
{
Description: Optional, integer. The unit count of SignalR resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100 ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Settings used to provision or configure the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
externalIP:
{
Description: The publicly accessible IP of the SignalR service. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the SignalR service instance. Format: xxx.service.signalr.net ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the SignalR service which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the SignalR service which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the SignalR resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private endpoint connection ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the private endpoint connection ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
kind:
{
Description: The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR" ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SignalR_Restart (removed)
Description :  Operation to restart a SignalR service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the SignalR resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Usages_List (removed)
Description :  List usage quotas for Azure SignalR service by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages
{
location:
{
Description: the location like "eastus" ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SignalR usages ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ARM resource id ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value for the usage quota. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted value for the usage quota. If there is no limit, this value will be -1. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Localizable String object containing the name and a localized value. ,
Required: False ,
}
{
value:
{
Description: The identifier of the usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name of the usage. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: True ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
}