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

2025/08/29 • 35 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available REST API operations of the Microsoft.SignalRService provider."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of Operation items",
        "old": "Result of the request to list REST API operations. It contains a list of operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Operation items on this page",
            "old": "List of operations supported by the resource provider."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "serviceSpecification": [
                    {
                      "metricSpecifications": {
                        "$properties": [
                          {
                            "#name": "fillGapWithZero",
                            "Description": {
                              "new": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.",
                              "old": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted."
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.SignalRService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Operation items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Checks that the resource name is valid and is not already in use.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "The region"
      }
    },
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "Parameters supplied to the operation."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability
{
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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  List resource usage quotas by location.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Usages_List",
  "$parameters": [
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "the location like \"eastus\""
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SignalRServiceUsage items on this page",
            "old": "List of the resource usages"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages
{
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 ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SignalRServiceUsage items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The WebPubSubResource items on this page",
            "old": "List of the resources"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Unknown",
                                "Unknown provisioning state"
                              ],
                              [
                                "Succeeded",
                                "Resource successfully provisioned"
                              ],
                              [
                                "Failed",
                                "Resource provisioning failed"
                              ],
                              [
                                "Canceled",
                                "Resource provisioning was canceled"
                              ],
                              [
                                "Running",
                                "Resource provisioning is running"
                              ],
                              [
                                "Creating",
                                "Resource is being created"
                              ],
                              [
                                "Updating",
                                "Resource is being updated"
                              ],
                              [
                                "Deleting",
                                "Resource is being deleted"
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Unknown",
                                ""
                              ],
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ],
                              [
                                "Canceled",
                                ""
                              ],
                              [
                                "Running",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Updating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "sharedPrivateLinkResources": {
                    "$properties": {
                      "properties": [
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Unknown",
                                "Unknown provisioning state"
                              ],
                              [
                                "Succeeded",
                                "Resource successfully provisioned"
                              ],
                              [
                                "Failed",
                                "Resource provisioning failed"
                              ],
                              [
                                "Canceled",
                                "Resource provisioning was canceled"
                              ],
                              [
                                "Running",
                                "Resource provisioning is running"
                              ],
                              [
                                "Creating",
                                "Resource is being created"
                              ],
                              [
                                "Updating",
                                "Resource is being updated"
                              ],
                              [
                                "Deleting",
                                "Resource is being deleted"
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Unknown",
                                ""
                              ],
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ],
                              [
                                "Canceled",
                                ""
                              ],
                              [
                                "Running",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Updating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "liveTraceConfiguration": [
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    },
                    {
                      "categories": {
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                              "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                            }
                          },
                          {
                            "#name": "enabled",
                            "Description": {
                              "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                              "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                {
                  "resourceLogConfiguration": [
                    {
                      "categories": {
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                              "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                            }
                          },
                          {
                            "#name": "enabled",
                            "Description": {
                              "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                              "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
                    "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
                  }
                },
                {
                  "#name": "disableLocalAuth",
                  "Description": {
                    "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
                    "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
                  }
                },
                {
                  "#name": "disableAadAuth",
                  "Description": {
                    "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
                    "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
                  }
                },
                {
                  "#name": "regionEndpointEnabled",
                  "Description": {
                    "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
                    "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
                  }
                },
                {
                  "#name": "resourceStopped",
                  "Description": {
                    "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
                    "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
                  }
                },
                {
                  "socketIO": [
                    {
                      "#name": "serviceMode",
                      "Description": {
                        "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                        "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                      }
                    }
                  ]
                }
              ],
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
                    "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
                    "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
                  },
                  "Enum": {
                    "new": [
                      [
                        "Free",
                        "Free tier for WebPubSub service"
                      ],
                      [
                        "Basic",
                        "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                      ],
                      [
                        "Standard",
                        "Standard tier for WebPubSub service"
                      ],
                      [
                        "Premium",
                        "Premium tier for WebPubSub service"
                      ]
                    ],
                    "old": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
                    "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
                  }
                }
              ],
              "identity": [
                {
                  "#name": "principalId",
                  "Description": {
                    "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
                    "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
                    "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: The WebPubSubResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The WebPubSubResource items on this page",
            "old": "List of the resources"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Unknown",
                                "Unknown provisioning state"
                              ],
                              [
                                "Succeeded",
                                "Resource successfully provisioned"
                              ],
                              [
                                "Failed",
                                "Resource provisioning failed"
                              ],
                              [
                                "Canceled",
                                "Resource provisioning was canceled"
                              ],
                              [
                                "Running",
                                "Resource provisioning is running"
                              ],
                              [
                                "Creating",
                                "Resource is being created"
                              ],
                              [
                                "Updating",
                                "Resource is being updated"
                              ],
                              [
                                "Deleting",
                                "Resource is being deleted"
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Unknown",
                                ""
                              ],
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ],
                              [
                                "Canceled",
                                ""
                              ],
                              [
                                "Running",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Updating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "sharedPrivateLinkResources": {
                    "$properties": {
                      "properties": [
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Unknown",
                                "Unknown provisioning state"
                              ],
                              [
                                "Succeeded",
                                "Resource successfully provisioned"
                              ],
                              [
                                "Failed",
                                "Resource provisioning failed"
                              ],
                              [
                                "Canceled",
                                "Resource provisioning was canceled"
                              ],
                              [
                                "Running",
                                "Resource provisioning is running"
                              ],
                              [
                                "Creating",
                                "Resource is being created"
                              ],
                              [
                                "Updating",
                                "Resource is being updated"
                              ],
                              [
                                "Deleting",
                                "Resource is being deleted"
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Unknown",
                                ""
                              ],
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ],
                              [
                                "Canceled",
                                ""
                              ],
                              [
                                "Running",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Updating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Moving",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "liveTraceConfiguration": [
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    },
                    {
                      "categories": {
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                              "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                            }
                          },
                          {
                            "#name": "enabled",
                            "Description": {
                              "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                              "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                {
                  "resourceLogConfiguration": [
                    {
                      "categories": {
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": {
                              "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                              "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                            }
                          },
                          {
                            "#name": "enabled",
                            "Description": {
                              "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                              "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                            }
                          }
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "publicNetworkAccess",
                  "Description": {
                    "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
                    "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
                  }
                },
                {
                  "#name": "disableLocalAuth",
                  "Description": {
                    "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
                    "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
                  }
                },
                {
                  "#name": "disableAadAuth",
                  "Description": {
                    "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
                    "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
                  }
                },
                {
                  "#name": "regionEndpointEnabled",
                  "Description": {
                    "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
                    "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
                  }
                },
                {
                  "#name": "resourceStopped",
                  "Description": {
                    "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
                    "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
                  }
                },
                {
                  "socketIO": [
                    {
                      "#name": "serviceMode",
                      "Description": {
                        "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                        "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                      }
                    }
                  ]
                }
              ],
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
                    "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
                    "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
                  },
                  "Enum": {
                    "new": [
                      [
                        "Free",
                        "Free tier for WebPubSub service"
                      ],
                      [
                        "Basic",
                        "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                      ],
                      [
                        "Standard",
                        "Standard tier for WebPubSub service"
                      ],
                      [
                        "Premium",
                        "Premium tier for WebPubSub service"
                      ]
                    ],
                    "old": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
                    "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
                  }
                }
              ],
              "identity": [
                {
                  "#name": "principalId",
                  "Description": {
                    "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
                    "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
                  }
                },
                {
                  "#name": "tenantId",
                  "Description": {
                    "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
                    "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: The WebPubSubResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the resource and its properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    }
  }
}

⚼ 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)

{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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 (updated)
Description :  Create or update a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /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 ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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 (200)

{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
}
,
$schema:
{
Description: A class represent a resource. ,
}
{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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_Update (updated)
Description :  Operation to update an exiting resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "sharedPrivateLinkResources": {
              "$properties": {
                "properties": [
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Unknown",
                          "Unknown provisioning state"
                        ],
                        [
                          "Succeeded",
                          "Resource successfully provisioned"
                        ],
                        [
                          "Failed",
                          "Resource provisioning failed"
                        ],
                        [
                          "Canceled",
                          "Resource provisioning was canceled"
                        ],
                        [
                          "Running",
                          "Resource provisioning is running"
                        ],
                        [
                          "Creating",
                          "Resource is being created"
                        ],
                        [
                          "Updating",
                          "Resource is being updated"
                        ],
                        [
                          "Deleting",
                          "Resource is being deleted"
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Unknown",
                          ""
                        ],
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ],
                        [
                          "Canceled",
                          ""
                        ],
                        [
                          "Running",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Updating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Moving",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "liveTraceConfiguration": [
              {
                "#name": "enabled",
                "Description": {
                  "new": "Indicates whether or not enable live trace.\nWhen it's set to true, live trace client can connect to the service.\nOtherwise, 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\".\nAvailable values: true, false.\nCase insensitive.",
                  "old": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, 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\".\r\nAvailable values: true, false.\r\nCase insensitive."
                }
              },
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the live trace category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the live trace category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "resourceLogConfiguration": [
              {
                "categories": {
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": {
                        "new": "Gets or sets the resource log category's name.\nAvailable values: ConnectivityLogs, MessagingLogs.\nCase insensitive.",
                        "old": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive."
                      }
                    },
                    {
                      "#name": "enabled",
                      "Description": {
                        "new": "Indicates whether or the resource log category is enabled.\nAvailable values: true, false.\nCase insensitive.",
                        "old": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "publicNetworkAccess",
            "Description": {
              "new": "Enable or disable public network access. Default to \"Enabled\".\nWhen it's Enabled, network ACLs still apply.\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
              "old": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs."
            }
          },
          {
            "#name": "disableLocalAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable local auth with AccessKey\nWhen set as true, connection with AccessKey=xxx won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work."
            }
          },
          {
            "#name": "disableAadAuth",
            "Description": {
              "new": "DisableLocalAuth\nEnable or disable aad auth\nWhen set as true, connection with AuthType=aad won't work.",
              "old": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work."
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\nThis property is replica specific. Disable the regional endpoint without replica is not allowed.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.\r\nThis property is replica specific. Disable the regional endpoint without replica is not allowed."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"False\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"False\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          },
          {
            "socketIO": [
              {
                "#name": "serviceMode",
                "Description": {
                  "new": "The service mode of Web PubSub for Socket.IO. Values allowed:\n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server",
                  "old": "The service mode of Web PubSub for Socket.IO. Values allowed: \r\n\"Default\": have your own backend Socket.IO server\r\n\"Serverless\": your application doesn't have a backend server"
                }
              }
            ]
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ],
        "identity": [
          {
            "#name": "principalId",
            "Description": {
              "new": "Get the principal id for the system assigned identity.\nOnly be used in response.",
              "old": "Get the principal id for the system assigned identity.\r\nOnly be used in response."
            }
          },
          {
            "#name": "tenantId",
            "Description": {
              "new": "Get the tenant id for the system assigned identity.\nOnly be used in response",
              "old": "Get the tenant id for the system assigned identity.\r\nOnly be used in response"
            }
          }
        ]
      }
    },
    "202": [
      {
        "@added_4239fca1db30459599f5f7dcbc65860b": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /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 ,
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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 (200)

{
properties:
{
Description: A class that describes the properties of the resource ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
WebPubSubCustomCertificates_List (updated)
Description :  List all custom certificates.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomCertificates_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The CustomCertificate items on this page",
            "old": "List of custom certificates of this resource."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates
{
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 CustomCertificate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get a custom certificate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomCertificates_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
{
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 ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  Create or update a custom certificate.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomCertificates_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
{
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 ,
certificateName:
{
Description: Custom certificate name ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A custom certificate. ,
}
{
properties:
{
Description: Custom certificate properties. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
]
,
}
,
}
WebPubSubCustomDomains_List (updated)
Description :  List all custom domains.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomDomains_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The CustomDomain items on this page",
            "old": "List of custom domains that bind to this resource."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains
{
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 CustomDomain items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get a custom domain.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomDomains_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
{
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 ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  Create or update a custom domain.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubCustomDomains_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
{
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 ,
name:
{
Description: Custom domain name. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
}
,
$schema:
{
Description: A custom domain ,
}
{
properties:
{
Description: Properties of a custom domain. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
]
,
}
,
}
WebPubSubHubs_List (updated)
Description :  List hub settings.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubHubs_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The WebPubSubHub items on this page",
            "old": "List of hub settings to this resource."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "eventHandlers": {
                    "$properties": [
                      {
                        "#name": "urlTemplate",
                        "Description": {
                          "new": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \nFor 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`.\nNote: 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.",
                          "old": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor 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`.\r\nNote: 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."
                        }
                      },
                      {
                        "#name": "userEventPattern",
                        "Description": {
                          "new": "Gets or sets the matching pattern for event names.\nThere are 3 kinds of patterns supported:\n1. \"*\", it matches any event name\n2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\n3. A single event name, for example, \"event1\", it matches \"event1\"",
                          "old": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n    1. \"*\", it matches any event name\r\n    2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n    3. A single event name, for example, \"event1\", it matches \"event1\""
                        }
                      },
                      {
                        "auth": [
                          {
                            "managedIdentity": [
                              {
                                "#name": "resource",
                                "Description": {
                                  "new": "The Resource indicating the App ID URI of the target resource.\nIt also appears in the aud (audience) claim of the issued token.",
                                  "old": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token."
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                },
                {
                  "#name": "eventListeners",
                  "Description": {
                    "new": "Event listener settings for forwarding your client events to listeners.\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\nOne 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.\nMaximum count of event listeners among all hubs is 10.",
                    "old": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne 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.\r\nMaximum count of event listeners among all hubs is 10."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: The WebPubSubHub items on this page ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get a hub setting.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubHubs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "eventHandlers": {
              "$properties": [
                {
                  "#name": "urlTemplate",
                  "Description": {
                    "new": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \nFor 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`.\nNote: 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.",
                    "old": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor 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`.\r\nNote: 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."
                  }
                },
                {
                  "#name": "userEventPattern",
                  "Description": {
                    "new": "Gets or sets the matching pattern for event names.\nThere are 3 kinds of patterns supported:\n1. \"*\", it matches any event name\n2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\n3. A single event name, for example, \"event1\", it matches \"event1\"",
                    "old": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n    1. \"*\", it matches any event name\r\n    2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n    3. A single event name, for example, \"event1\", it matches \"event1\""
                  }
                },
                {
                  "auth": [
                    {
                      "managedIdentity": [
                        {
                          "#name": "resource",
                          "Description": {
                            "new": "The Resource indicating the App ID URI of the target resource.\nIt also appears in the aud (audience) claim of the issued token.",
                            "old": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          {
            "#name": "eventListeners",
            "Description": {
              "new": "Event listener settings for forwarding your client events to listeners.\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\nOne 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.\nMaximum count of event listeners among all hubs is 10.",
              "old": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne 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.\r\nMaximum count of event listeners among all hubs is 10."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
{
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 ,
hubName:
{
Description: The hub name. ,
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 (updated)
Description :  Create or update a hub setting.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubHubs_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "eventHandlers": {
              "$properties": [
                {
                  "#name": "urlTemplate",
                  "Description": {
                    "new": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \nFor 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`.\nNote: 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.",
                    "old": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor 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`.\r\nNote: 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."
                  }
                },
                {
                  "#name": "userEventPattern",
                  "Description": {
                    "new": "Gets or sets the matching pattern for event names.\nThere are 3 kinds of patterns supported:\n1. \"*\", it matches any event name\n2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\n3. A single event name, for example, \"event1\", it matches \"event1\"",
                    "old": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n    1. \"*\", it matches any event name\r\n    2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n    3. A single event name, for example, \"event1\", it matches \"event1\""
                  }
                },
                {
                  "auth": [
                    {
                      "managedIdentity": [
                        {
                          "#name": "resource",
                          "Description": {
                            "new": "The Resource indicating the App ID URI of the target resource.\nIt also appears in the aud (audience) claim of the issued token.",
                            "old": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          {
            "#name": "eventListeners",
            "Description": {
              "new": "Event listener settings for forwarding your client events to listeners.\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\nOne 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.\nMaximum count of event listeners among all hubs is 10.",
              "old": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne 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.\r\nMaximum count of event listeners among all hubs is 10."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "eventHandlers": {
              "$properties": [
                {
                  "#name": "urlTemplate",
                  "Description": {
                    "new": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \nFor 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`.\nNote: 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.",
                    "old": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor 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`.\r\nNote: 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."
                  }
                },
                {
                  "#name": "userEventPattern",
                  "Description": {
                    "new": "Gets or sets the matching pattern for event names.\nThere are 3 kinds of patterns supported:\n1. \"*\", it matches any event name\n2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\n3. A single event name, for example, \"event1\", it matches \"event1\"",
                    "old": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n    1. \"*\", it matches any event name\r\n    2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n    3. A single event name, for example, \"event1\", it matches \"event1\""
                  }
                },
                {
                  "auth": [
                    {
                      "managedIdentity": [
                        {
                          "#name": "resource",
                          "Description": {
                            "new": "The Resource indicating the App ID URI of the target resource.\nIt also appears in the aud (audience) claim of the issued token.",
                            "old": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          {
            "#name": "eventListeners",
            "Description": {
              "new": "Event listener settings for forwarding your client events to listeners.\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\nOne 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.\nMaximum count of event listeners among all hubs is 10.",
              "old": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne 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.\r\nMaximum count of event listeners among all hubs is 10."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "eventHandlers": {
              "$properties": [
                {
                  "#name": "urlTemplate",
                  "Description": {
                    "new": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \nFor 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`.\nNote: 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.",
                    "old": "Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. \r\nThe template supports predefined parameters syntax: `{event}`, `{hub}`, and KeyVault reference syntax `{@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)}` \r\nFor 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`.\r\nNote: 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."
                  }
                },
                {
                  "#name": "userEventPattern",
                  "Description": {
                    "new": "Gets or sets the matching pattern for event names.\nThere are 3 kinds of patterns supported:\n1. \"*\", it matches any event name\n2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\n3. A single event name, for example, \"event1\", it matches \"event1\"",
                    "old": "Gets or sets the matching pattern for event names.\r\nThere are 3 kinds of patterns supported:\r\n    1. \"*\", it matches any event name\r\n    2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n    3. A single event name, for example, \"event1\", it matches \"event1\""
                  }
                },
                {
                  "auth": [
                    {
                      "managedIdentity": [
                        {
                          "#name": "resource",
                          "Description": {
                            "new": "The Resource indicating the App ID URI of the target resource.\nIt also appears in the aud (audience) claim of the issued token.",
                            "old": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          {
            "#name": "eventListeners",
            "Description": {
              "new": "Event listener settings for forwarding your client events to listeners.\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\nOne 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.\nMaximum count of event listeners among all hubs is 10.",
              "old": "Event listener settings for forwarding your client events to listeners.\r\nEvent listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients.\r\nOne 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.\r\nMaximum count of event listeners among all hubs is 10."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
{
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 ,
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 ,
}
,
}
,
}

⚐ 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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A hub setting ,
}
{
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 ,
}
,
]
,
}
,
}
WebPubSubPrivateEndpointConnections_List (updated)
Description :  List private endpoint connections
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubPrivateEndpointConnections_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnection items on this page",
            "old": "The list of the private endpoint connections"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ 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 PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the specified private endpoint connection
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubPrivateEndpointConnections_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  Update the state of specified private endpoint connection
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubPrivateEndpointConnections_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (200)

{
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
]
,
}
,
}
WebPubSubPrivateLinkResources_List (updated)
Description :  Get the private link resources that need to be created for a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubPrivateLinkResources_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "List of PrivateLinkResource"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List all replicas belong to this resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicas_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Replica items on this page",
            "old": "List of the replica"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "regionEndpointEnabled",
                  "Description": {
                    "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
                    "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
                  }
                },
                {
                  "#name": "resourceStopped",
                  "Description": {
                    "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
                    "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
                  }
                }
              ],
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
                    "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
                    "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
                  },
                  "Enum": {
                    "new": [
                      [
                        "Free",
                        "Free tier for WebPubSub service"
                      ],
                      [
                        "Basic",
                        "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                      ],
                      [
                        "Standard",
                        "Standard tier for WebPubSub service"
                      ],
                      [
                        "Premium",
                        "Premium tier for WebPubSub service"
                      ]
                    ],
                    "old": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
                    "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas
{
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 Replica items on this page ,
Required: True ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the replica and its properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicas_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Create or update a replica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicas_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A class represent a replica resource. ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Operation to update an exiting replica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicas_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "regionEndpointEnabled",
            "Description": {
              "new": "Enable or disable the regional endpoint. Default to \"Enabled\".\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.",
              "old": "Enable or disable the regional endpoint. Default to \"Enabled\".\r\nWhen it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected."
            }
          },
          {
            "#name": "resourceStopped",
            "Description": {
              "new": "Stop or start the resource.  Default to \"false\".\nWhen it's true, the data plane of the resource is shutdown.\nWhen it's false, the data plane of the resource is started.",
              "old": "Stop or start the resource.  Default to \"false\".\r\nWhen it's true, the data plane of the resource is shutdown.\r\nWhen it's false, the data plane of the resource is started."
            }
          }
        ],
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
              "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
            }
          },
          {
            "#name": "tier",
            "Description": {
              "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
              "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
            },
            "Enum": {
              "new": [
                [
                  "Free",
                  "Free tier for WebPubSub service"
                ],
                [
                  "Basic",
                  "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                ],
                [
                  "Standard",
                  "Standard tier for WebPubSub service"
                ],
                [
                  "Premium",
                  "Premium tier for WebPubSub service"
                ]
              ],
              "old": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "capacity",
            "Description": {
              "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
              "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
{
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: A class represent a replica resource. ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 ,
}
,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Operation to restart a replica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicas_Restart",
  "$responses": {
    "202": [
      {
        "@added_8b207a50e43142b3b5b6ce3559fe96d8": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  List shared private link resources
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicaSharedPrivateLinkResources_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SharedPrivateLinkResource items on this page",
            "old": "The list of the shared private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SharedPrivateLinkResource items on this page ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicaSharedPrivateLinkResources_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link 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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Shared Private Link Resource ,
}
{
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  List all available skus of the replica resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_ListReplicaSkus",
  "$responses": {
    "200": {
      "$properties": [
        {
          "value": {
            "$properties": {
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
                    "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
                    "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
                  },
                  "Enum": {
                    "new": [
                      [
                        "Free",
                        "Free tier for WebPubSub service"
                      ],
                      [
                        "Basic",
                        "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                      ],
                      [
                        "Standard",
                        "Standard tier for WebPubSub service"
                      ],
                      [
                        "Premium",
                        "Premium tier for WebPubSub service"
                      ]
                    ],
                    "old": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
                    "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The URL the client should use to fetch the next page (per server side paging).\nIt's null for now, added for future use.",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/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 ,
replicaName:
{
Description: The name of the replica. ,
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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 (updated)
Description :  Operation to restart a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_Restart",
  "$responses": {
    "202": [
      {
        "@added_aaa19997b4324ce999f664deb3bf09d4": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  List shared private link resources
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubSharedPrivateLinkResources_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SharedPrivateLinkResource items on this page",
            "old": "The list of the shared private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "Unknown provisioning state"
                      ],
                      [
                        "Succeeded",
                        "Resource successfully provisioned"
                      ],
                      [
                        "Failed",
                        "Resource provisioning failed"
                      ],
                      [
                        "Canceled",
                        "Resource provisioning was canceled"
                      ],
                      [
                        "Running",
                        "Resource provisioning is running"
                      ],
                      [
                        "Creating",
                        "Resource is being created"
                      ],
                      [
                        "Updating",
                        "Resource is being updated"
                      ],
                      [
                        "Deleting",
                        "Resource is being deleted"
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Running",
                        ""
                      ],
                      [
                        "Creating",
                        ""
                      ],
                      [
                        "Updating",
                        ""
                      ],
                      [
                        "Deleting",
                        ""
                      ],
                      [
                        "Moving",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "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."
          }
        }
      ]
    }
  }
}

⚼ 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 SharedPrivateLinkResource items on this page ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the specified shared private link resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubSharedPrivateLinkResources_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
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 ,
sharedPrivateLinkResourceName:
{
Description: The name of the shared private link 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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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 (updated)
Description :  Create or update a shared private link resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "Unknown provisioning state"
                ],
                [
                  "Succeeded",
                  "Resource successfully provisioned"
                ],
                [
                  "Failed",
                  "Resource provisioning failed"
                ],
                [
                  "Canceled",
                  "Resource provisioning was canceled"
                ],
                [
                  "Running",
                  "Resource provisioning is running"
                ],
                [
                  "Creating",
                  "Resource is being created"
                ],
                [
                  "Updating",
                  "Resource is being updated"
                ],
                [
                  "Deleting",
                  "Resource is being deleted"
                ],
                [
                  "Moving",
                  ""
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Running",
                  ""
                ],
                [
                  "Creating",
                  ""
                ],
                [
                  "Updating",
                  ""
                ],
                [
                  "Deleting",
                  ""
                ],
                [
                  "Moving",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
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 ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a Shared Private Link Resource ,
}
{
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: Unknown provisioning state ,
Succeeded: Resource successfully provisioned ,
Failed: Resource provisioning failed ,
Canceled: Resource provisioning was canceled ,
Running: Resource provisioning is running ,
Creating: Resource is being created ,
Updating: Resource is being updated ,
Deleting: Resource is being deleted ,
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_ListSkus (updated)
Description :  List all available skus of the resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebPubSub_ListSkus",
  "$responses": {
    "200": {
      "$properties": [
        {
          "value": {
            "$properties": {
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU. Required.\n\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2",
                    "old": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2"
                  }
                },
                {
                  "#name": "tier",
                  "Description": {
                    "new": "Optional tier of this particular SKU. 'Standard' or 'Free'.\n\n`Basic` is deprecated, use `Standard` instead.",
                    "old": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead."
                  },
                  "Enum": {
                    "new": [
                      [
                        "Free",
                        "Free tier for WebPubSub service"
                      ],
                      [
                        "Basic",
                        "Basic tier for WebPubSub service (deprecated, use Standard instead)"
                      ],
                      [
                        "Standard",
                        "Standard tier for WebPubSub service"
                      ],
                      [
                        "Premium",
                        "Premium tier for WebPubSub service"
                      ]
                    ],
                    "old": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "capacity",
                  "Description": {
                    "new": "Optional, integer. The unit count of the resource.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\nFree_F1: 1;\nStandard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\nPremium_P2:  100,200,300,400,500,600,700,800,900,1000;",
                    "old": "Optional, integer. The unit count of the resource.\r\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free_F1: 1;\r\n    Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P1:  1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n    Premium_P2:  100,200,300,400,500,600,700,800,900,1000;"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The URL the client should use to fetch the next page (per server side paging).\nIt's null for now, added for future use.",
            "old": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    }
  }
}

⚼ 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: Free tier for WebPubSub service ,
Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) ,
Standard: Standard tier for WebPubSub service ,
Premium: Premium tier for WebPubSub service ,
}
,
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 ,
}
,
]
,
}
,
}