Microsoft.SignalRService (preview:2025-01-01)

2025/05/29 • 84 new 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: The API version to use for this operation. ,
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 a 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 Operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: An object that describes a specification. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_CheckNameAvailability (new)
Description :  Checks that the resource 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: True ,
}
{
type:
{
Description: The resource type. Can be "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" or "Microsoft.SignalRService/WebPubSub/replicas" ,
Required: True ,
}
string ,
name:
{
Description: The resource name to validate. e.g."my-resource-name" ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Usages_List (new)
Description :  List resource usage quotas 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resource 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resources ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resources ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_Get (new)
Description :  Get the resource and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_CreateOrUpdate (new)
Description :  Create or update a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_Delete (new)
Description :  Operation to delete a resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_Update (new)
Description :  Operation to update an exiting resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
features:
{
Description: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. ,
Required: False ,
}
[
{
flag:
{
Description: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. ,
Enum:
{
ServiceMode: No description available. ,
EnableConnectivityLogs: No description available. ,
EnableMessagingLogs: No description available. ,
EnableLiveTrace: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. ,
Required: True ,
}
string ,
properties:
{
Description: Optional properties related to this feature. ,
Required: False ,
}
object ,
}
,
]
,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. ,
Required: False ,
}
[
string ,
]
,
}
,
serverless:
{
Description: Serverless settings. ,
Required: False ,
}
{
connectionTimeoutInSeconds:
{
Description: Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. ,
Format: int32 ,
Required: False ,
}
integer ,
keepAliveIntervalInSeconds:
{
Description: Gets or sets the Keep-Alive Interval. Optional to set. Value is in seconds. The default value is 15 seconds. Customers should set this value to a shorter period if they want the service to send keep-alive messages more frequently, ensuring timely checks of the connection status. Conversely, customers can set this value to a longer period if they want the service to send keep-alive messages less frequently, reducing network traffic, but note that it may take longer to detect a disconnection. This interval ensures that the connection is maintained by sending periodic keep-alive messages to the client. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
upstream:
{
Description: The settings for the Upstream when the service is in server-less mode. ,
Required: False ,
}
{
templates:
{
Description: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ,
Required: False ,
}
[
{
hubPattern:
{
Description: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1". ,
Required: False ,
}
string ,
eventPattern:
{
Description: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect". ,
Required: False ,
}
string ,
categoryPattern:
{
Description: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections". ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. ,
Required: True ,
}
string ,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
routeSettings:
{
Description: Route settings for the resource ,
Required: False ,
}
{
serverBalanceWeight:
{
Description: Gets or sets the server balance weight. A higher value means a greater balance of client connections across different app server instances. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for multiple app servers in same size. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionBalanceWeight:
{
Description: Gets or sets the connection balance weight. A higher value means a greater balance of client connections across different server connections. A value of 0 distributes connections randomly, while a value of 255 ensures maximum balancing. The default value is 255. Recommended ```255``` for all of the cases. ,
Format: int32 ,
Required: False ,
}
integer ,
latencyWeight:
{
Description: Gets or sets the weight for latency-based routing. A higher value increases the influence of latency-based routing. A value of 0 disables latency-based routing entirely, while a value of 255 enables it fully. The default value is 0. Recommended ```255``` for replicas or app servers in different regions for disaster recovery. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
SignalR: No description available. ,
RawWebSockets: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomCertificates_List (new)
Description :  List all custom certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of custom certificates of this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomCertificates_Get (new)
Description :  Get a custom certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomCertificates_CreateOrUpdate (new)
Description :  Create or update a custom certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomCertificates_Delete (new)
Description :  Delete a custom certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomDomains_List (new)
Description :  List all custom domains.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of custom domains that bind to this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomDomains_Get (new)
Description :  Get a custom domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomDomains_CreateOrUpdate (new)
Description :  Create or update a custom domain.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRCustomDomains_Delete (new)
Description :  Delete a custom domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_ListKeys (new)
Description :  Get the access keys of the resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the 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: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRPrivateEndpointConnections_List (new)
Description :  List private endpoint connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRPrivateEndpointConnections_Get (new)
Description :  Get the specified private endpoint connection
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 Azure resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRPrivateEndpointConnections_Update (new)
Description :  Update the state of specified private endpoint connection
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 Azure resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource of private endpoint and its properties ,
Required: True ,
}
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRPrivateEndpointConnections_Delete (new)
Description :  Delete the specified private endpoint connection
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 Azure resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRPrivateLinkResources_List (new)
Description :  Get the private link resources that need to be created for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of PrivateLinkResource ,
Required: False ,
}
[
{
properties:
{
Description: Private link resource properties ,
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 ,
]
,
shareablePrivateLinkResourceTypes:
{
Description: The list of resources that are onboarded to private link service ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource type that has been onboarded to private link service ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a resource type that has been onboarded to private link service ,
Required: False ,
}
{
description:
{
Description: The description of the resource type that has been onboarded to private link service ,
Required: False ,
}
string ,
groupId:
{
Description: The resource provider group id for the resource that has been onboarded to private link service ,
Required: False ,
}
string ,
type:
{
Description: The resource provider type for the resource that has been onboarded to private link service ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_RegenerateKey (new)
Description :  Regenerate the access key for the resource. 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: True ,
}
{
keyType:
{
Description: The type of access key. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
Salt: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the 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: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: A class represents the access keys of the resource. ,
}
{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_List (new)
Description :  List all replicas belong to this resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the replica ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_Get (new)
Description :  Get the replica and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_CreateOrUpdate (new)
Description :  Create or update a replica.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_Delete (new)
Description :  Operation to delete a replica.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_Update (new)
Description :  Operation to update an exiting replica.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: A class represent a replica resource. ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicas_Restart (new)
Description :  Operation to restart a replica.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/restart
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicaSharedPrivateLinkResources_List (new)
Description :  List shared private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the shared private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicaSharedPrivateLinkResources_Get (new)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRReplicaSharedPrivateLinkResources_CreateOrUpdate (new)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared private link resource ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_ListReplicaSkus (new)
Description :  List all available skus of the replica resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this object applies to ,
Required: False ,
}
string ,
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacity:
{
Description: Describes scaling information of a sku. ,
Required: False ,
}
{
minimum:
{
Description: The lowest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedValues:
{
Description: Allows capacity value list. ,
Required: False ,
}
[
integer ,
]
,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Automatic: 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_Restart (new)
Description :  Operation to restart a resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRSharedPrivateLinkResources_List (new)
Description :  List shared private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the shared private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRSharedPrivateLinkResources_Get (new)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRSharedPrivateLinkResources_CreateOrUpdate (new)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared private link resource ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalRSharedPrivateLinkResources_Delete (new)
Description :  Delete the specified shared private link resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SignalR_ListSkus (new)
Description :  List all available skus of the resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this object applies to ,
Required: False ,
}
string ,
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacity:
{
Description: Describes scaling information of a sku. ,
Required: False ,
}
{
minimum:
{
Description: The lowest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedValues:
{
Description: Allows capacity value list. ,
Required: False ,
}
[
integer ,
]
,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Automatic: 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
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 a 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 Operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: An object that describes a specification. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_CheckNameAvailability (new)
Description :  Checks that the resource 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: True ,
}
{
type:
{
Description: The resource type. Can be "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" or "Microsoft.SignalRService/WebPubSub/replicas" ,
Required: True ,
}
string ,
name:
{
Description: The resource name to validate. e.g."my-resource-name" ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Usages_List (new)
Description :  List resource usage quotas 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resource 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_ListBySubscription (new)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resources ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_ListByResourceGroup (new)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the resources ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_Get (new)
Description :  Get the resource and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_CreateOrUpdate (new)
Description :  Create or update a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_Delete (new)
Description :  Operation to delete a resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_Update (new)
Description :  Operation to update an exiting resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: A class that describes the properties of 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 resource. ,
Required: False ,
}
string ,
hostName:
{
Description: FQDN of the service instance. ,
Required: False ,
}
string ,
publicPort:
{
Description: The publicly accessible port of the resource which is designed for browser/client side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
serverPort:
{
Description: The publicly accessible port of the resource which is designed for customer server side usage. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version of the resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private endpoint connections to the resource. ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
tls:
{
Description: TLS settings for the resource ,
Required: False ,
}
{
clientCertEnabled:
{
Description: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. ,
Required: False ,
}
boolean ,
}
,
hostNamePrefix:
{
Description: Deprecated. ,
Required: False ,
}
string ,
liveTraceConfiguration:
{
Description: Live trace configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
resourceLogConfiguration:
{
Description: Resource log configuration of a Microsoft.SignalRService resource. ,
Required: False ,
}
{
categories:
{
Description: Gets or sets the list of category configurations. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. ,
Required: False ,
}
string ,
}
,
]
,
}
,
networkACLs:
{
Description: Network ACLs for the resource ,
Required: False ,
}
{
defaultAction:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetwork:
{
Description: Network ACL ,
Required: False ,
}
{
allow:
{
Description: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
deny:
{
Description: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. ,
Required: False ,
}
[
string ,
]
,
}
,
privateEndpoints:
{
Description: ACLs for requests from private endpoints ,
Required: False ,
}
[
{
name:
{
Description: Name of the private endpoint connection ,
Required: True ,
}
string ,
}
,
]
,
ipRules:
{
Description: IP rules for filtering public traffic ,
Required: False ,
}
[
{
value:
{
Description: An IP or CIDR or ServiceTag ,
Required: False ,
}
string ,
action:
{
Description: Azure Networking ACL Action. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
applicationFirewall:
{
Description: Application firewall settings for the resource ,
Required: False ,
}
{
clientConnectionCountRules:
{
Description: Rules to control the client connection count ,
Required: False ,
}
[
{
type:
{
Enum:
{
ThrottleByJwtSignatureRule: No description available. ,
ThrottleByUserIdRule: No description available. ,
ThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clientTrafficControlRules:
{
Description: Rules to control the client traffic ,
Required: False ,
}
[
{
type:
{
Enum:
{
TrafficThrottleByJwtSignatureRule: No description available. ,
TrafficThrottleByUserIdRule: No description available. ,
TrafficThrottleByJwtCustomClaimRule: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxClientConnectionLifetimeInSeconds:
{
Description: Config to control the client connection lifetime in seconds, can be set to 0 to disable the config ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
publicNetworkAccess:
{
Description: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs. ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work. ,
Required: False ,
}
boolean ,
disableAadAuth:
{
Description: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work. ,
Required: False ,
}
boolean ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
socketIO:
{
Description: SocketIO settings for the resource ,
Required: False ,
}
{
serviceMode:
{
Description: The service mode of Web PubSub for Socket.IO. Values allowed: "Default": have your own backend Socket.IO server "Serverless": your application doesn't have a backend server ,
Required: False ,
}
string ,
}
,
}
,
kind:
{
Description: The kind of the service ,
Enum:
{
WebPubSub: No description available. ,
SocketIO: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: A class represent managed identities used for request and response ,
Required: False ,
}
{
type:
{
Description: Represents the identity type: systemAssigned, userAssigned, None ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Get or set the user assigned identities ,
Required: False ,
}
object ,
principalId:
{
Description: Get the principal id for the system assigned identity. Only be used in response. ,
Required: False ,
}
string ,
tenantId:
{
Description: Get the tenant id for the system assigned identity. Only be used in response ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomCertificates_List (new)
Description :  List all custom certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of custom certificates of this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomCertificates_Get (new)
Description :  Get a custom certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomCertificates_CreateOrUpdate (new)
Description :  Create or update a custom certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
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 ,
keyVaultBaseUri:
{
Description: Base uri of the KeyVault that stores certificate. ,
Required: True ,
}
string ,
keyVaultSecretName:
{
Description: Certificate secret name. ,
Required: True ,
}
string ,
keyVaultSecretVersion:
{
Description: Certificate secret version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomCertificates_Delete (new)
Description :  Delete a custom certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomDomains_List (new)
Description :  List all custom domains.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of custom domains that bind to this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomDomains_Get (new)
Description :  Get a custom domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomDomains_CreateOrUpdate (new)
Description :  Create or update a custom domain.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
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 ,
domainName:
{
Description: The custom domain name. ,
Required: True ,
}
string ,
customCertificate:
{
Description: Reference to a resource. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubCustomDomains_Delete (new)
Description :  Delete a custom domain.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubHubs_List (new)
Description :  List hub settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of hub settings to this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a hub. ,
Required: True ,
}
{
eventHandlers:
{
Description: Event handler of a hub. ,
Required: False ,
}
[
{
urlTemplate:
{
Description: Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` For example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`. Note: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling. ,
Required: True ,
}
string ,
userEventPattern:
{
Description: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" ,
Required: False ,
}
string ,
systemEvents:
{
Description: Gets or sets the list of system events. ,
Required: False ,
}
[
string ,
]
,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
eventListeners:
{
Description: Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10. ,
Required: False ,
}
[
{
filter:
{
Description: A base class for event filter which determines whether an event should be sent to an event listener. ,
Required: True ,
}
{
type:
{
Enum:
{
EventName: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpoint:
{
Description: An endpoint specifying where Web PubSub should send events to. ,
Required: True ,
}
{
type:
{
Enum:
{
EventHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
anonymousConnectPolicy:
{
Description: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". ,
Required: False ,
}
string ,
webSocketKeepAliveIntervalInSeconds:
{
Description: The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubHubs_Get (new)
Description :  Get a hub setting.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
{
hubName:
{
Description: The hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a hub. ,
Required: True ,
}
{
eventHandlers:
{
Description: Event handler of a hub. ,
Required: False ,
}
[
{
urlTemplate:
{
Description: Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` For example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`. Note: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling. ,
Required: True ,
}
string ,
userEventPattern:
{
Description: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" ,
Required: False ,
}
string ,
systemEvents:
{
Description: Gets or sets the list of system events. ,
Required: False ,
}
[
string ,
]
,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
eventListeners:
{
Description: Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10. ,
Required: False ,
}
[
{
filter:
{
Description: A base class for event filter which determines whether an event should be sent to an event listener. ,
Required: True ,
}
{
type:
{
Enum:
{
EventName: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpoint:
{
Description: An endpoint specifying where Web PubSub should send events to. ,
Required: True ,
}
{
type:
{
Enum:
{
EventHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
anonymousConnectPolicy:
{
Description: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". ,
Required: False ,
}
string ,
webSocketKeepAliveIntervalInSeconds:
{
Description: The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubHubs_CreateOrUpdate (new)
Description :  Create or update a hub setting.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
{
hubName:
{
Description: The hub name. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource of WebPubSubHub and its properties ,
Required: True ,
}
{
properties:
{
Description: Properties of a hub. ,
Required: True ,
}
{
eventHandlers:
{
Description: Event handler of a hub. ,
Required: False ,
}
[
{
urlTemplate:
{
Description: Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` For example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`. Note: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling. ,
Required: True ,
}
string ,
userEventPattern:
{
Description: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" ,
Required: False ,
}
string ,
systemEvents:
{
Description: Gets or sets the list of system events. ,
Required: False ,
}
[
string ,
]
,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
eventListeners:
{
Description: Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10. ,
Required: False ,
}
[
{
filter:
{
Description: A base class for event filter which determines whether an event should be sent to an event listener. ,
Required: True ,
}
{
type:
{
Enum:
{
EventName: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpoint:
{
Description: An endpoint specifying where Web PubSub should send events to. ,
Required: True ,
}
{
type:
{
Enum:
{
EventHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
anonymousConnectPolicy:
{
Description: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". ,
Required: False ,
}
string ,
webSocketKeepAliveIntervalInSeconds:
{
Description: The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a hub. ,
Required: True ,
}
{
eventHandlers:
{
Description: Event handler of a hub. ,
Required: False ,
}
[
{
urlTemplate:
{
Description: Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` For example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`. Note: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling. ,
Required: True ,
}
string ,
userEventPattern:
{
Description: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" ,
Required: False ,
}
string ,
systemEvents:
{
Description: Gets or sets the list of system events. ,
Required: False ,
}
[
string ,
]
,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
eventListeners:
{
Description: Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10. ,
Required: False ,
}
[
{
filter:
{
Description: A base class for event filter which determines whether an event should be sent to an event listener. ,
Required: True ,
}
{
type:
{
Enum:
{
EventName: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpoint:
{
Description: An endpoint specifying where Web PubSub should send events to. ,
Required: True ,
}
{
type:
{
Enum:
{
EventHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
anonymousConnectPolicy:
{
Description: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". ,
Required: False ,
}
string ,
webSocketKeepAliveIntervalInSeconds:
{
Description: The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a hub. ,
Required: True ,
}
{
eventHandlers:
{
Description: Event handler of a hub. ,
Required: False ,
}
[
{
urlTemplate:
{
Description: Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` For example, if the template is `http://example.com/api/{event}`, when `connect` event is triggered, a POST request will be sent to the URL `http://example.com/chat/api/connect`. Note: Parameters are not allowed in the hostname of the URL, and curly brackets `{}` are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling. ,
Required: True ,
}
string ,
userEventPattern:
{
Description: Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1" ,
Required: False ,
}
string ,
systemEvents:
{
Description: Gets or sets the list of system events. ,
Required: False ,
}
[
string ,
]
,
auth:
{
Description: Upstream auth settings. If not set, no auth is used for upstream messages. ,
Required: False ,
}
{
type:
{
Description: Upstream auth type enum. ,
Enum:
{
None: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentity:
{
Description: Managed identity settings for upstream. ,
Required: False ,
}
{
resource:
{
Description: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
eventListeners:
{
Description: Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10. ,
Required: False ,
}
[
{
filter:
{
Description: A base class for event filter which determines whether an event should be sent to an event listener. ,
Required: True ,
}
{
type:
{
Enum:
{
EventName: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpoint:
{
Description: An endpoint specifying where Web PubSub should send events to. ,
Required: True ,
}
{
type:
{
Enum:
{
EventHub: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
anonymousConnectPolicy:
{
Description: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". ,
Required: False ,
}
string ,
webSocketKeepAliveIntervalInSeconds:
{
Description: The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubHubs_Delete (new)
Description :  Delete a hub setting.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
{
hubName:
{
Description: The hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_ListKeys (new)
Description :  Get the access keys of the resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the 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: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubPrivateEndpointConnections_List (new)
Description :  List private endpoint connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubPrivateEndpointConnections_Get (new)
Description :  Get the specified private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubPrivateEndpointConnections_Update (new)
Description :  Update the state of specified private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource of private endpoint and its properties ,
Required: True ,
}
{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private endpoint connection properties ,
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 ,
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: Full qualified Id of the private endpoint ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubPrivateEndpointConnections_Delete (new)
Description :  Delete the specified private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubPrivateLinkResources_List (new)
Description :  Get the private link resources that need to be created for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of PrivateLinkResource ,
Required: False ,
}
[
{
properties:
{
Description: Private link resource properties ,
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 ,
]
,
shareablePrivateLinkResourceTypes:
{
Description: The list of resources that are onboarded to private link service ,
Required: False ,
}
[
{
name:
{
Description: The name of the resource type that has been onboarded to private link service ,
Required: False ,
}
string ,
properties:
{
Description: Describes the properties of a resource type that has been onboarded to private link service ,
Required: False ,
}
{
description:
{
Description: The description of the resource type that has been onboarded to private link service ,
Required: False ,
}
string ,
groupId:
{
Description: The resource provider group id for the resource that has been onboarded to private link service ,
Required: False ,
}
string ,
type:
{
Description: The resource provider type for the resource that has been onboarded to private link service ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_RegenerateKey (new)
Description :  Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey
{
parameters:
{
Description: Parameter that describes the Regenerate Key Operation. ,
Required: True ,
}
{
keyType:
{
Description: The type of access key. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
Salt: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the 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: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: A class represents the access keys of the resource. ,
}
{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: Connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_List (new)
Description :  List all replicas belong to this resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of the replica ,
Required: False ,
}
[
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_Get (new)
Description :  Get the replica and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_CreateOrUpdate (new)
Description :  Create or update a replica.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_Delete (new)
Description :  Operation to delete a replica.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_Update (new)
Description :  Operation to update an exiting replica.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: A class represent a replica resource. ,
}
{
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
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 ,
regionEndpointEnabled:
{
Description: Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. ,
Required: False ,
}
string ,
resourceStopped:
{
Description: Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicas_Restart (new)
Description :  Operation to restart a replica.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicaSharedPrivateLinkResources_List (new)
Description :  List shared private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the shared private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicaSharedPrivateLinkResources_Get (new)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate (new)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared private link resource ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_ListReplicaSkus (new)
Description :  List all available skus of the replica resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this object applies to ,
Required: False ,
}
string ,
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacity:
{
Description: Describes scaling information of a sku. ,
Required: False ,
}
{
minimum:
{
Description: The lowest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedValues:
{
Description: Allows capacity value list. ,
Required: False ,
}
[
integer ,
]
,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Automatic: 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_Restart (new)
Description :  Operation to restart a resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubSharedPrivateLinkResources_List (new)
Description :  List shared private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of the shared private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubSharedPrivateLinkResources_Get (new)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubSharedPrivateLinkResources_CreateOrUpdate (new)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared private link resource ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an existing Shared Private Link Resource ,
Required: False ,
}
{
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for ,
Required: True ,
}
string ,
privateLinkResourceId:
{
Description: The resource id of the resource the shared private link resource is for ,
Required: True ,
}
string ,
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 ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource ,
Required: False ,
}
string ,
fqdns:
{
Description: A list of FQDNs for third party private link service ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: Status of the shared private link resource ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSubSharedPrivateLinkResources_Delete (new)
Description :  Delete the specified shared private link resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WebPubSub_ListSkus (new)
Description :  List all available skus of the resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of skus available for the resource. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type that this object applies to ,
Required: False ,
}
string ,
sku:
{
Description: The billing information of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 ,
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 the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
capacity:
{
Description: Describes scaling information of a sku. ,
Required: False ,
}
{
minimum:
{
Description: The lowest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The highest permitted capacity for this resource ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
allowedValues:
{
Description: Allows capacity value list. ,
Required: False ,
}
[
integer ,
]
,
scaleType:
{
Description: The scale type applicable to the sku. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Automatic: 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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}