swagger: '2.0' info: title: Microsoft Azure WebPubSubManagementClient description: REST API for Azure WebPubSub Service version: 2024-01-01-preview paths: /providers/Microsoft.SignalRService/operations: get: tags: - WebPubSub description: >- Lists all of the available REST API operations of the Microsoft.SignalRService provider. operationId: microsoftAzureOperationsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes the list of operations. schema: $ref: '#/definitions/OperationList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Operations_List: $ref: ./examples/Operations_List.json summary: Microsoft Azure Get Providers Microsoft Signalrservice Operations /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability: post: tags: - WebPubSub description: Checks that the resource name is valid and is not already in use. operationId: microsoftAzureWebpubsubChecknameavailability produces: - application/json parameters: - in: path name: location description: the region required: true type: string - in: body name: parameters description: Parameters supplied to the operation. required: true schema: $ref: '#/definitions/NameAvailabilityParameters' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Success. The response describes the name availability. schema: $ref: '#/definitions/NameAvailability' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSub_CheckNameAvailability: $ref: ./examples/WebPubSub_CheckNameAvailability.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages: get: tags: - WebPubSub description: List resource usage quotas by location. operationId: microsoftAzureUsagesList produces: - application/json parameters: - in: path name: location description: the location like "eastus" required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Success. The response describe the usage quotas of a subscription in specified region. schema: $ref: '#/definitions/SignalRServiceUsageList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Usages_List: $ref: ./examples/Usages_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Usages /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub: get: tags: - WebPubSub description: Handles requests to list all resources in a subscription. operationId: microsoftAzureWebpubsubListbysubscription produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Success. The response describes the list of resources in the subscription. schema: $ref: '#/definitions/WebPubSubResourceList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSub_ListBySubscription: $ref: ./examples/WebPubSub_ListBySubscription.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Webpubsub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub: get: tags: - WebPubSub description: Handles requests to list all resources in a resource group. operationId: microsoftAzureWebpubsubListbyresourcegroup produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: >- Success. The response describes the list of resources in a resourceGroup. schema: $ref: '#/definitions/WebPubSubResourceList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSub_ListByResourceGroup: $ref: ./examples/WebPubSub_ListByResourceGroup.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} : get: tags: - WebPubSub description: Get the resource and its properties. operationId: microsoftAzureWebpubsubGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes the corresponding resource. schema: $ref: '#/definitions/WebPubSubResource' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSub_Get: $ref: ./examples/WebPubSub_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename put: tags: - WebPubSub description: Create or update a resource. operationId: microsoftAzureWebpubsubCreateorupdate produces: - application/json parameters: - in: body name: parameters description: Parameters for the create or update operation required: true schema: $ref: '#/definitions/WebPubSubResource' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes a resource. schema: $ref: '#/definitions/WebPubSubResource' '201': description: >- Created. The response describes the new resource and contains a Location header to query the operation result. schema: $ref: '#/definitions/WebPubSubResource' '202': description: >- Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSub_CreateOrUpdate: $ref: ./examples/WebPubSub_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename delete: tags: - WebPubSub description: Operation to delete a resource. operationId: microsoftAzureWebpubsubDelete parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response indicates the resource is already deleted. '202': description: >- Accepted. The response indicates the delete operation is performed in the background. '204': description: Success. The response indicates the resource is already deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSub_Delete: $ref: ./examples/WebPubSub_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename patch: tags: - WebPubSub description: Operation to update an exiting resource. operationId: microsoftAzureWebpubsubUpdate produces: - application/json parameters: - in: body name: parameters description: Parameters for the update operation required: true schema: $ref: '#/definitions/WebPubSubResource' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes a resource. schema: $ref: '#/definitions/WebPubSubResource' '202': description: >- Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.. headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSub_Update: $ref: ./examples/WebPubSub_Update.json summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates : get: tags: - WebPubSub description: List all custom certificates. operationId: microsoftAzureWebpubsubcustomcertificatesList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes custom certificates of the resource. schema: $ref: '#/definitions/CustomCertificateList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubCustomCertificates_List: $ref: ./examples/WebPubSubCustomCertificates_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName} : get: tags: - WebPubSub description: Get a custom certificate. operationId: microsoftAzureWebpubsubcustomcertificatesGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describe the corresponding custom certificate. schema: $ref: '#/definitions/CustomCertificate' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubCustomCertificates_Get: $ref: ./examples/WebPubSubCustomCertificates_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename put: tags: - WebPubSub description: Create or update a custom certificate. operationId: microsoftAzureWebpubsubcustomcertificatesCreateorupdate consumes: - application/json - text/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: '' required: true schema: $ref: '#/definitions/CustomCertificate' responses: '200': description: Success. The response describes the certificate. schema: $ref: '#/definitions/CustomCertificate' '201': description: Created. The response describes the certificate. schema: $ref: '#/definitions/CustomCertificate' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubCustomCertificates_CreateOrUpdate: $ref: ./examples/WebPubSubCustomCertificates_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename delete: tags: - WebPubSub description: Delete a custom certificate. operationId: microsoftAzureWebpubsubcustomcertificatesDelete parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. '204': description: No Content. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubCustomCertificates_Delete: $ref: ./examples/WebPubSubCustomCertificates_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains : get: tags: - WebPubSub description: List all custom domains. operationId: microsoftAzureWebpubsubcustomdomainsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes custom domains of the resource. schema: $ref: '#/definitions/CustomDomainList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubCustomDomains_List: $ref: ./examples/WebPubSubCustomDomains_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name} : get: tags: - WebPubSub description: Get a custom domain. operationId: microsoftAzureWebpubsubcustomdomainsGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describe the corresponding custom domain. schema: $ref: '#/definitions/CustomDomain' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubCustomDomains_Get: $ref: ./examples/WebPubSubCustomDomains_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name put: tags: - WebPubSub description: Create or update a custom domain. operationId: microsoftAzureWebpubsubcustomdomainsCreateorupdate consumes: - application/json - text/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: '' required: true schema: $ref: '#/definitions/CustomDomain' responses: '201': description: >- Created. The response describes the custom domain and contains a Location header to query the operation result. schema: $ref: '#/definitions/CustomDomain' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubCustomDomains_CreateOrUpdate: $ref: ./examples/WebPubSubCustomDomains_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name delete: tags: - WebPubSub description: Delete a custom domain. operationId: microsoftAzureWebpubsubcustomdomainsDelete parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response indicates the custom domain is deleted. '202': description: >- Accepted. The response indicates the operation is performed in the background. '204': description: Success. The response indicates the custom domain is deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubCustomDomains_Delete: $ref: ./examples/WebPubSubCustomDomains_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs : get: tags: - WebPubSub description: List hub settings. operationId: microsoftAzureWebpubsubhubsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes hub settings of the resource. schema: $ref: '#/definitions/WebPubSubHubList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubHubs_List: $ref: ./examples/WebPubSubHubs_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName} : get: tags: - WebPubSub description: Get a hub setting. operationId: microsoftAzureWebpubsubhubsGet produces: - application/json parameters: - in: path name: hubName description: The hub name. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describe the corresponding hub setting. schema: $ref: '#/definitions/WebPubSubHub' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubHubs_Get: $ref: ./examples/WebPubSubHubs_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname put: tags: - WebPubSub description: Create or update a hub setting. operationId: microsoftAzureWebpubsubhubsCreateorupdate produces: - application/json parameters: - in: path name: hubName description: The hub name. required: true type: string - in: body name: parameters description: The resource of WebPubSubHub and its properties required: true schema: $ref: '#/definitions/WebPubSubHub' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: >- OK.The request makes no change. The response describes the existing hub setting. schema: $ref: '#/definitions/WebPubSubHub' '201': description: >- Created. The response describes the hub setting and contains a Location header to query the operation result. schema: $ref: '#/definitions/WebPubSubHub' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubHubs_CreateOrUpdate: $ref: ./examples/WebPubSubHubs_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname delete: tags: - WebPubSub description: Delete a hub setting. operationId: microsoftAzureWebpubsubhubsDelete parameters: - in: path name: hubName description: The hub name. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: OK. '202': description: >- Accepted. The response indicates the delete operation is performed in the background. '204': description: Success. The response indicates the hub setting is already deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubHubs_Delete: $ref: ./examples/WebPubSubHubs_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys : post: tags: - WebPubSub description: Get the access keys of the resource. operationId: microsoftAzureWebpubsubListkeys produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes access keys of the resource. schema: $ref: '#/definitions/WebPubSubKeys' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSub_ListKeys: $ref: ./examples/WebPubSub_ListKeys.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Listkeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections : get: tags: - WebPubSub description: List private endpoint connections operationId: microsoftAzureWebpubsubprivateendpointconnectionsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: >- Success. The response describes a list of private endpoint connections. schema: $ref: '#/definitions/PrivateEndpointConnectionList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubPrivateEndpointConnections_List: $ref: ./examples/WebPubSubPrivateEndpointConnections_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - WebPubSub description: Get the specified private endpoint connection operationId: microsoftAzureWebpubsubprivateendpointconnectionsGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes a private endpoint connection. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubPrivateEndpointConnections_Get: $ref: ./examples/WebPubSubPrivateEndpointConnections_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname put: tags: - WebPubSub description: Update the state of specified private endpoint connection operationId: microsoftAzureWebpubsubprivateendpointconnectionsUpdate produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName - in: body name: parameters description: The resource of private endpoint and its properties required: true schema: $ref: '#/definitions/PrivateEndpointConnection' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: >- OK. The response indicates the private endpoint connection is updated successfully. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubPrivateEndpointConnections_Update: $ref: ./examples/WebPubSubPrivateEndpointConnections_Update.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - WebPubSub description: Delete the specified private endpoint connection operationId: microsoftAzureWebpubsubprivateendpointconnectionsDelete parameters: - $ref: >- ../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response indicates the resource is already deleted. '202': description: >- Accepted. The response indicates the delete operation is performed in the background. '204': description: >- Success. The response indicates the private endpoint connection is already deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubPrivateEndpointConnections_Delete: $ref: ./examples/WebPubSubPrivateEndpointConnections_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources : get: tags: - WebPubSub description: Get the private link resources that need to be created for a resource. operationId: microsoftAzureWebpubsubprivatelinkresourcesList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes a list of private link resources. schema: $ref: '#/definitions/PrivateLinkResourceList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubPrivateLinkResources_List: $ref: ./examples/WebPubSubPrivateLinkResources_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey : post: tags: - WebPubSub description: >- Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time. operationId: microsoftAzureWebpubsubRegeneratekey produces: - application/json parameters: - in: body name: parameters description: Parameter that describes the Regenerate Key Operation. required: true schema: $ref: '#/definitions/RegenerateKeyParameters' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success schema: $ref: '#/definitions/WebPubSubKeys' '202': description: >- Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result. schema: $ref: '#/definitions/WebPubSubKeys' headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSub_RegenerateKey: $ref: ./examples/WebPubSub_RegenerateKey.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Regeneratekey ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas : get: tags: - WebPubSub description: List all replicas belong to this resource operationId: microsoftAzureWebpubsubreplicasList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes replicas of the resource. schema: $ref: '#/definitions/ReplicaList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubReplicas_List: $ref: ./examples/WebPubSubReplicas_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} : get: tags: - WebPubSub description: Get the replica and its properties. operationId: microsoftAzureWebpubsubreplicasGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes the corresponding replica. schema: $ref: '#/definitions/Replica' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubReplicas_Get: $ref: ./examples/WebPubSubReplicas_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname put: tags: - WebPubSub description: Create or update a replica. operationId: microsoftAzureWebpubsubreplicasCreateorupdate consumes: - application/json - text/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Parameters for the create or update operation required: true schema: $ref: '#/definitions/Replica' responses: '200': description: Updated. The response describes a replica. schema: $ref: '#/definitions/Replica' '201': description: >- Created. The response describes the new replica and contains a Location header to query the operation result. schema: $ref: '#/definitions/Replica' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubReplicas_CreateOrUpdate: $ref: ./examples/WebPubSubReplicas_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname delete: tags: - WebPubSub description: Operation to delete a replica. operationId: microsoftAzureWebpubsubreplicasDelete parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response indicates the replica is deleted. '204': description: Success. The response indicates the replica is deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubReplicas_Delete: $ref: ./examples/WebPubSubReplicas_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname patch: tags: - WebPubSub description: Operation to update an exiting replica. operationId: microsoftAzureWebpubsubreplicasUpdate consumes: - application/json - text/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Parameters for the update operation required: true schema: $ref: '#/definitions/Replica' responses: '200': description: Success. The response describes a replica. schema: $ref: '#/definitions/Replica' '202': description: >- Updated. The response describes the new replica and contains a Location header to query the operation result. schema: $ref: '#/definitions/Replica' headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubReplicas_Update: $ref: ./examples/WebPubSubReplicas_Update.json summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart : post: tags: - WebPubSub description: Operation to restart a replica. operationId: microsoftAzureWebpubsubreplicasRestart parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: >- Accepted. The response indicates the restart operation is performed in the background. headers: Location: type: string '204': description: >- Success. The response indicates the operation is successful and no content will be returned. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubReplicas_Restart: $ref: ./examples/WebPubSubReplicas_Restart.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Restart ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources : get: tags: - WebPubSub description: List shared private link resources operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: >- Success. The response describes a list of shared private link resources. schema: $ref: '#/definitions/SharedPrivateLinkResourceList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubReplicaSharedPrivateLinkResources_List: $ref: ./examples/WebPubSubReplicaSharedPrivateLinkResources_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : get: tags: - WebPubSub description: Get the specified shared private link resource operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: '#/parameters/SharedPrivateLinkResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes a shared private link resource. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubReplicaSharedPrivateLinkResources_Get: $ref: ./examples/WebPubSubReplicaSharedPrivateLinkResources_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources Sharedprivatelinkresourcename put: tags: - WebPubSub description: Create or update a shared private link resource operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesCreateorupdate consumes: - application/json - text/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: '#/parameters/SharedPrivateLinkResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: The shared private link resource required: true schema: $ref: '#/definitions/SharedPrivateLinkResource' responses: '200': description: >- OK. The response indicates the shared private link resource is updated. schema: $ref: '#/definitions/SharedPrivateLinkResource' '201': description: >- Created. The response indicates the shared private link resource is created. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate: $ref: >- ./examples/WebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources Sharedprivatelinkresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus : get: tags: - WebPubSub description: List all available skus of the replica resource. operationId: microsoftAzureWebpubsubListreplicaskus produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ReplicaName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: >- Success. The response describes all available skus of the replica resource. schema: $ref: '#/definitions/SkuList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSub_ListReplicaSkus: $ref: ./examples/WebPubSub_ListReplicaSkus.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Skus ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart : post: tags: - WebPubSub description: Operation to restart a resource. operationId: microsoftAzureWebpubsubRestart parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '202': description: >- Accepted. The response indicates the restart operation is performed in the background. headers: Location: type: string '204': description: >- Success. The response indicates the operation is successful and no content will be returned. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSub_Restart: $ref: ./examples/WebPubSub_Restart.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Restart ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources : get: tags: - WebPubSub description: List shared private link resources operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: >- Success. The response describes a list of shared private link resources. schema: $ref: '#/definitions/SharedPrivateLinkResourceList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: WebPubSubSharedPrivateLinkResources_List: $ref: ./examples/WebPubSubSharedPrivateLinkResources_List.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : get: tags: - WebPubSub description: Get the specified shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesGet produces: - application/json parameters: - $ref: '#/parameters/SharedPrivateLinkResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes a shared private link resource. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSubSharedPrivateLinkResources_Get: $ref: ./examples/WebPubSubSharedPrivateLinkResources_Get.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename put: tags: - WebPubSub description: Create or update a shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesCreateorupdate produces: - application/json parameters: - $ref: '#/parameters/SharedPrivateLinkResourceName' - in: body name: parameters description: The shared private link resource required: true schema: $ref: '#/definitions/SharedPrivateLinkResource' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: >- OK. The response indicates the shared private link resource is updated. schema: $ref: '#/definitions/SharedPrivateLinkResource' '201': description: >- Created. The response indicates the shared private link resource is created. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: WebPubSubSharedPrivateLinkResources_CreateOrUpdate: $ref: ./examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename delete: tags: - WebPubSub description: Delete the specified shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesDelete parameters: - $ref: '#/parameters/SharedPrivateLinkResourceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response indicates the resource is already deleted. '202': description: >- Accepted. The response indicates the delete operation is performed in the background. '204': description: >- Success. The response indicates the private endpoint connection is already deleted. default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WebPubSubSharedPrivateLinkResources_Delete: $ref: ./examples/WebPubSubSharedPrivateLinkResources_Delete.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus : get: tags: - WebPubSub description: List all available skus of the resource. operationId: microsoftAzureWebpubsubListskus produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ResourceName' responses: '200': description: Success. The response describes all available skus of the resource. schema: $ref: '#/definitions/SkuList' default: description: Error response describing why the operation failed. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WebPubSub_ListSkus: $ref: ./examples/WebPubSub_ListSkus.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Skus definitions: ACLAction: description: Azure Networking ACL Action. enum: - Allow - Deny type: string x-ms-enum: name: ACLAction modelAsString: true CustomCertificate: description: A custom certificate. required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/CustomCertificateProperties' CustomCertificateList: description: Custom certificates list. type: object properties: value: description: List of custom certificates of this resource. type: array items: $ref: '#/definitions/CustomCertificate' x-ms-identifiers: [] nextLink: description: "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." type: string CustomCertificateProperties: description: Custom certificate properties. required: - keyVaultBaseUri - keyVaultSecretName type: object properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' keyVaultBaseUri: description: Base uri of the KeyVault that stores certificate. type: string x-ms-mutability: - read - create keyVaultSecretName: description: Certificate secret name. type: string x-ms-mutability: - read - create keyVaultSecretVersion: description: Certificate secret version. type: string x-ms-mutability: - read - create CustomDomain: description: A custom domain required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/CustomDomainProperties' CustomDomainList: description: Custom domains list type: object properties: value: description: List of custom domains that bind to this resource. type: array items: $ref: '#/definitions/CustomDomain' x-ms-identifiers: [] nextLink: description: "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." type: string CustomDomainProperties: description: Properties of a custom domain. required: - customCertificate - domainName type: object properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' domainName: description: The custom domain name. type: string customCertificate: $ref: '#/definitions/ResourceReference' Dimension: description: Specifications of the Dimension of metrics. type: object properties: name: description: The public facing name of the dimension. type: string displayName: description: Localized friendly display name of the dimension. type: string internalName: description: Name of the dimension as it appears in MDM. type: string toBeExportedForShoebox: description: >- A Boolean flag indicating whether this dimension should be included for the shoebox export scenario. type: boolean EventHandler: description: Properties of event handler. required: - urlTemplate type: object properties: urlTemplate: description: "Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.\r\nFor example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters." type: string userEventPattern: description: "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\"" type: string systemEvents: description: Gets or sets the list of system events. type: array items: type: string x-ms-identifiers: [] auth: $ref: '#/definitions/UpstreamAuthSettings' EventHubEndpoint: description: "An Event Hub endpoint. \r\nThe managed identity of Web PubSub service must be enabled, and the identity should have the \"Azure Event Hubs Data sender\" role to access Event Hub." required: - eventHubName - fullyQualifiedNamespace type: object allOf: - $ref: '#/definitions/EventListenerEndpoint' properties: fullyQualifiedNamespace: description: >- The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net". type: string eventHubName: description: The name of the Event Hub. type: string x-ms-discriminator-value: EventHub EventListener: description: A setting defines which kinds of events should be sent to which endpoint. required: - endpoint - filter type: object properties: filter: $ref: '#/definitions/EventListenerFilter' endpoint: $ref: '#/definitions/EventListenerEndpoint' EventListenerEndpoint: description: An endpoint specifying where Web PubSub should send events to. required: - type type: object properties: type: enum: - EventHub type: string x-ms-enum: name: EventListenerEndpointDiscriminator modelAsString: true discriminator: type EventListenerFilter: description: >- A base class for event filter which determines whether an event should be sent to an event listener. required: - type type: object properties: type: enum: - EventName type: string x-ms-enum: name: EventListenerFilterDiscriminator modelAsString: true discriminator: type EventNameFilter: description: Filter events by their name. type: object allOf: - $ref: '#/definitions/EventListenerFilter' properties: systemEvents: description: >- Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response. type: array items: type: string x-ms-identifiers: [] userEventPattern: description: "Gets or sets a 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 events \"event1\" and \"event2\"\r\n 3. A single event name, for example, \"event1\", it matches \"event1\"" type: string x-ms-discriminator-value: EventName IPRule: description: An IP rule type: object properties: value: description: An IP or CIDR or ServiceTag type: string action: $ref: '#/definitions/ACLAction' KeyType: description: The type of access key. enum: - Primary - Secondary - Salt type: string x-ms-enum: name: KeyType modelAsString: true LiveTraceCategory: description: Live trace category configuration of a Microsoft.SignalRService resource. type: object properties: name: description: "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive." type: string enabled: description: "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive." type: string LiveTraceConfiguration: description: Live trace configuration of a Microsoft.SignalRService resource. type: object properties: enabled: description: "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." default: 'false' type: string categories: description: Gets or sets the list of category configurations. type: array items: $ref: '#/definitions/LiveTraceCategory' x-ms-identifiers: - name LogSpecification: description: Specifications of the Logs for Azure Monitoring. type: object properties: name: description: Name of the log. type: string displayName: description: Localized friendly display name of the log. type: string ManagedIdentity: description: A class represent managed identities used for request and response type: object properties: type: $ref: '#/definitions/ManagedIdentityType' userAssignedIdentities: description: Get or set the user assigned identities type: object additionalProperties: $ref: '#/definitions/UserAssignedIdentityProperty' principalId: description: "Get the principal id for the system assigned identity.\r\nOnly be used in response." type: string readOnly: true tenantId: description: "Get the tenant id for the system assigned identity.\r\nOnly be used in response" type: string readOnly: true ManagedIdentitySettings: description: Managed identity settings for upstream. type: object properties: resource: description: "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token." type: string ManagedIdentityType: description: 'Represents the identity type: systemAssigned, userAssigned, None' enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: name: ManagedIdentityType modelAsString: true MetricSpecification: description: Specifications of the Metrics for Azure Monitoring. type: object properties: name: description: Name of the metric. type: string displayName: description: Localized friendly display name of the metric. type: string displayDescription: description: Localized friendly description of the metric. type: string unit: description: The unit that makes sense for the metric. type: string aggregationType: description: >- Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. type: string fillGapWithZero: description: "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." type: string category: description: >- The name of the metric category that the metric belongs to. A metric can only belong to a single category. type: string dimensions: description: The dimensions of the metrics. type: array items: $ref: '#/definitions/Dimension' x-ms-identifiers: - name NameAvailability: description: >- Result of the request to check name availability. It contains a flag and possible reason of failure. type: object properties: nameAvailable: description: Indicates whether the name is available or not. type: boolean reason: description: The reason of the availability. Required if name is not available. type: string message: description: The message of the operation. type: string NameAvailabilityParameters: description: Data POST-ed to the nameAvailability action required: - name - type type: object properties: type: description: >- The resource type. Can be "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" or "Microsoft.SignalRService/WebPubSub/replicas" type: string name: description: The resource name to validate. e.g."my-resource-name" type: string NetworkACL: description: Network ACL type: object properties: allow: description: >- Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. type: array items: $ref: '#/definitions/WebPubSubRequestType' x-ms-identifiers: [] deny: description: >- Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. type: array items: $ref: '#/definitions/WebPubSubRequestType' x-ms-identifiers: [] Operation: description: REST API operation supported by resource provider. type: object properties: name: description: 'Name of the operation with format: {provider}/{resource}/{operation}' type: string isDataAction: description: If the operation is a data action. (for data plane rbac) type: boolean display: $ref: '#/definitions/OperationDisplay' origin: description: >- Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. type: string properties: x-ms-client-flatten: false $ref: '#/definitions/OperationProperties' OperationDisplay: description: The object that describes a operation. type: object properties: provider: description: Friendly name of the resource provider type: string resource: description: Resource type on which the operation is performed. type: string operation: description: The localized friendly name for the operation. type: string description: description: The localized friendly description for the operation type: string OperationList: description: >- Result of the request to list REST API operations. It contains a list of operations. type: object properties: value: description: List of operations supported by the resource provider. type: array items: $ref: '#/definitions/Operation' x-ms-identifiers: - name nextLink: description: "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." type: string OperationProperties: description: Extra Operation properties. type: object properties: serviceSpecification: $ref: '#/definitions/ServiceSpecification' PrivateEndpoint: description: Private endpoint type: object properties: id: description: Full qualified Id of the private endpoint type: string PrivateEndpointACL: description: ACL for a private endpoint required: - name type: object allOf: - $ref: '#/definitions/NetworkACL' properties: name: description: Name of the private endpoint connection type: string PrivateEndpointConnection: description: A private endpoint connection to an azure resource type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PrivateEndpointConnectionProperties' PrivateEndpointConnectionList: description: A list of private endpoint connections type: object properties: value: description: The list of the private endpoint connections type: array items: $ref: '#/definitions/PrivateEndpointConnection' x-ms-identifiers: [] nextLink: description: >- Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. type: string PrivateEndpointConnectionProperties: description: Private endpoint connection properties type: object properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' privateEndpoint: $ref: '#/definitions/PrivateEndpoint' groupIds: description: Group IDs type: array items: type: string readOnly: true x-ms-identifiers: [] privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState' PrivateLinkResource: description: Private link resource type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PrivateLinkResourceProperties' PrivateLinkResourceList: description: >- Contains a list of PrivateLinkResource and a possible link to query more results type: object properties: value: description: List of PrivateLinkResource type: array items: $ref: '#/definitions/PrivateLinkResource' x-ms-identifiers: [] nextLink: description: "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." type: string PrivateLinkResourceProperties: description: Private link resource properties type: object properties: groupId: description: Group Id of the private link resource type: string requiredMembers: description: Required members of the private link resource type: array items: type: string x-ms-identifiers: [] requiredZoneNames: description: Required private DNS zone names type: array items: type: string x-ms-identifiers: [] shareablePrivateLinkResourceTypes: description: The list of resources that are onboarded to private link service type: array items: $ref: '#/definitions/ShareablePrivateLinkResourceType' x-ms-identifiers: [] PrivateLinkServiceConnectionState: description: Connection state of the private endpoint connection type: object properties: status: $ref: '#/definitions/PrivateLinkServiceConnectionStatus' description: description: The reason for approval/rejection of the connection. type: string actionsRequired: description: >- A message indicating if changes on the service provider require any updates on the consumer. type: string PrivateLinkServiceConnectionStatus: description: >- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. enum: - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: true ProvisioningState: description: Provisioning state of the resource. enum: - Unknown - Succeeded - Failed - Canceled - Running - Creating - Updating - Deleting - Moving type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true RegenerateKeyParameters: description: Parameters describes the request to regenerate access keys type: object properties: keyType: $ref: '#/definitions/KeyType' Replica: description: A class represent a replica resource. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: sku: $ref: '#/definitions/ResourceSku' properties: x-ms-client-flatten: true $ref: '#/definitions/ReplicaProperties' ReplicaList: type: object properties: value: description: List of the replica type: array items: $ref: '#/definitions/Replica' nextLink: description: "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." type: string ReplicaProperties: type: object properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' regionEndpointEnabled: description: "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." default: Enabled type: string resourceStopped: description: "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." default: 'false' type: string ResourceLogCategory: description: >- Resource log category configuration of a Microsoft.SignalRService resource. type: object properties: name: description: "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive." type: string enabled: description: "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive." type: string ResourceLogConfiguration: description: Resource log configuration of a Microsoft.SignalRService resource. type: object properties: categories: description: Gets or sets the list of category configurations. type: array items: $ref: '#/definitions/ResourceLogCategory' x-ms-identifiers: - name ResourceReference: description: Reference to a resource. type: object properties: id: description: Resource ID. type: string ResourceSku: description: The billing information of the resource. required: - name type: object properties: name: description: "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2" type: string tier: $ref: '#/definitions/WebPubSubSkuTier' size: description: Not used. Retained for future use. type: string readOnly: true family: description: Not used. Retained for future use. type: string readOnly: true capacity: format: int32 description: "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;" type: integer ScaleType: description: The scale type applicable to the sku. enum: - None - Manual - Automatic type: string x-ms-enum: name: ScaleType modelAsString: true ServiceKind: description: The kind of the service enum: - WebPubSub - SocketIO type: string x-ms-enum: name: ServiceKind modelAsString: true ServiceSpecification: description: An object that describes a specification. type: object properties: metricSpecifications: description: Specifications of the Metrics for Azure Monitoring. type: array items: $ref: '#/definitions/MetricSpecification' x-ms-identifiers: - name - unit logSpecifications: description: Specifications of the Logs for Azure Monitoring. type: array items: $ref: '#/definitions/LogSpecification' x-ms-identifiers: - name ShareablePrivateLinkResourceProperties: description: >- Describes the properties of a resource type that has been onboarded to private link service type: object properties: description: description: >- The description of the resource type that has been onboarded to private link service type: string groupId: description: >- The resource provider group id for the resource that has been onboarded to private link service type: string type: description: >- The resource provider type for the resource that has been onboarded to private link service type: string ShareablePrivateLinkResourceType: description: Describes a resource type that has been onboarded to private link service type: object properties: name: description: >- The name of the resource type that has been onboarded to private link service type: string properties: $ref: '#/definitions/ShareablePrivateLinkResourceProperties' SharedPrivateLinkResource: description: Describes a Shared Private Link Resource type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SharedPrivateLinkResourceProperties' SharedPrivateLinkResourceList: description: A list of shared private link resources type: object properties: value: description: The list of the shared private link resources type: array items: $ref: '#/definitions/SharedPrivateLinkResource' x-ms-identifiers: [] nextLink: description: >- Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. type: string SharedPrivateLinkResourceProperties: description: Describes the properties of an existing Shared Private Link Resource required: - groupId - privateLinkResourceId type: object properties: groupId: description: >- The group id from the provider of resource the shared private link resource is for type: string privateLinkResourceId: description: >- The resource id of the resource the shared private link resource is for type: string provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' requestMessage: description: >- The request message for requesting approval of the shared private link resource type: string status: readOnly: true $ref: '#/definitions/SharedPrivateLinkResourceStatus' SharedPrivateLinkResourceStatus: description: Status of the shared private link resource enum: - Pending - Approved - Rejected - Disconnected - Timeout type: string x-ms-enum: name: SharedPrivateLinkResourceStatus modelAsString: true SignalRServiceUsage: description: Object that describes a specific usage of the resources. type: object properties: id: description: Fully qualified ARM resource id type: string currentValue: format: int64 description: Current value for the usage quota. type: integer limit: format: int64 description: >- The maximum permitted value for the usage quota. If there is no limit, this value will be -1. type: integer name: $ref: '#/definitions/SignalRServiceUsageName' unit: description: >- Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. type: string SignalRServiceUsageList: description: >- Object that includes an array of the resource usages and a possible link for next set. type: object properties: value: description: List of the resource usages type: array items: $ref: '#/definitions/SignalRServiceUsage' x-ms-identifiers: [] nextLink: description: "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." type: string SignalRServiceUsageName: description: Localizable String object containing the name and a localized value. type: object properties: value: description: The identifier of the usage. type: string localizedValue: description: Localized name of the usage. type: string Sku: description: Describes an available sku." type: object properties: resourceType: description: The resource type that this object applies to type: string readOnly: true sku: readOnly: true $ref: '#/definitions/ResourceSku' capacity: readOnly: true $ref: '#/definitions/SkuCapacity' SkuCapacity: description: Describes scaling information of a sku. type: object properties: minimum: format: int32 description: The lowest permitted capacity for this resource type: integer readOnly: true maximum: format: int32 description: The highest permitted capacity for this resource type: integer readOnly: true default: format: int32 description: The default capacity. type: integer readOnly: true allowedValues: description: Allows capacity value list. type: array items: format: int32 type: integer readOnly: true x-ms-identifiers: [] scaleType: readOnly: true $ref: '#/definitions/ScaleType' SkuList: description: The list skus operation response type: object properties: value: description: The list of skus available for the resource. type: array items: $ref: '#/definitions/Sku' readOnly: true x-ms-identifiers: - resourceType - /sku/name - /sku/tier nextLink: description: "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." type: string readOnly: true UpstreamAuthSettings: description: Upstream auth settings. If not set, no auth is used for upstream messages. type: object properties: type: $ref: '#/definitions/UpstreamAuthType' managedIdentity: $ref: '#/definitions/ManagedIdentitySettings' UpstreamAuthType: description: Upstream auth type enum. enum: - None - ManagedIdentity type: string x-ms-enum: name: UpstreamAuthType modelAsString: true UserAssignedIdentityProperty: description: Properties of user assigned identity. type: object properties: principalId: description: Get the principal id for the user assigned identity type: string readOnly: true clientId: description: Get the client id for the user assigned identity type: string readOnly: true WebPubSubHub: description: A hub setting required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/WebPubSubHubProperties' WebPubSubHubList: description: Hub setting list type: object properties: value: description: List of hub settings to this resource. type: array items: $ref: '#/definitions/WebPubSubHub' x-ms-identifiers: [] nextLink: description: "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." type: string readOnly: true WebPubSubHubProperties: description: Properties of a hub. type: object properties: eventHandlers: description: Event handler of a hub. type: array items: $ref: '#/definitions/EventHandler' x-ms-identifiers: [] eventListeners: description: "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." type: array items: $ref: '#/definitions/EventListener' x-ms-identifiers: [] anonymousConnectPolicy: description: >- The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". default: deny type: string webSocketKeepAliveIntervalInSeconds: format: int32 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. default: 20 maximum: 120 minimum: 1 type: integer WebPubSubKeys: description: A class represents the access keys of the resource. type: object properties: primaryKey: description: The primary access key. type: string x-ms-secret: true secondaryKey: description: The secondary access key. type: string x-ms-secret: true primaryConnectionString: description: Connection string constructed via the primaryKey type: string x-ms-secret: true secondaryConnectionString: description: Connection string constructed via the secondaryKey type: string x-ms-secret: true WebPubSubNetworkACLs: description: Network ACLs for the resource type: object properties: defaultAction: $ref: '#/definitions/ACLAction' publicNetwork: $ref: '#/definitions/NetworkACL' privateEndpoints: description: ACLs for requests from private endpoints type: array items: $ref: '#/definitions/PrivateEndpointACL' x-ms-identifiers: - name ipRules: description: IP rules for filtering public traffic maxItems: 30 type: array items: $ref: '#/definitions/IPRule' x-ms-identifiers: [] WebPubSubProperties: description: A class that describes the properties of the resource type: object properties: provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' externalIP: description: The publicly accessible IP of the resource. type: string readOnly: true hostName: description: FQDN of the service instance. type: string readOnly: true publicPort: format: int32 description: >- The publicly accessible port of the resource which is designed for browser/client side usage. type: integer readOnly: true serverPort: format: int32 description: >- The publicly accessible port of the resource which is designed for customer server side usage. type: integer readOnly: true version: description: >- Version of the resource. Probably you need the same or higher version of client SDKs. type: string readOnly: true privateEndpointConnections: description: Private endpoint connections to the resource. type: array items: $ref: '#/definitions/PrivateEndpointConnection' readOnly: true x-ms-identifiers: [] sharedPrivateLinkResources: description: The list of shared private link resources. type: array items: $ref: '#/definitions/SharedPrivateLinkResource' readOnly: true x-ms-identifiers: [] tls: $ref: '#/definitions/WebPubSubTlsSettings' hostNamePrefix: description: Deprecated. type: string readOnly: true liveTraceConfiguration: $ref: '#/definitions/LiveTraceConfiguration' resourceLogConfiguration: $ref: '#/definitions/ResourceLogConfiguration' networkACLs: $ref: '#/definitions/WebPubSubNetworkACLs' publicNetworkAccess: description: "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." default: Enabled type: string disableLocalAuth: description: "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work." default: false type: boolean disableAadAuth: description: "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work." default: false type: boolean regionEndpointEnabled: description: "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." default: Enabled type: string resourceStopped: description: "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." default: 'false' type: string socketIO: $ref: '#/definitions/WebPubSubSocketIOSettings' WebPubSubRequestType: description: The incoming request type to the service enum: - ClientConnection - ServerConnection - RESTAPI - Trace type: string x-ms-enum: name: WebPubSubRequestType modelAsString: true WebPubSubResource: description: A class represent a resource. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: sku: $ref: '#/definitions/ResourceSku' properties: x-ms-client-flatten: true $ref: '#/definitions/WebPubSubProperties' kind: x-ms-mutability: - read - create $ref: '#/definitions/ServiceKind' identity: $ref: '#/definitions/ManagedIdentity' WebPubSubResourceList: description: >- Object that includes an array of resources and a possible link for next set. type: object properties: value: description: List of the resources type: array items: $ref: '#/definitions/WebPubSubResource' x-ms-identifiers: [] nextLink: description: "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." type: string WebPubSubSkuTier: description: "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." enum: - Free - Basic - Standard - Premium type: string x-ms-enum: name: WebPubSubSkuTier modelAsString: true WebPubSubSocketIOSettings: description: SocketIO settings for the resource type: object properties: serviceMode: description: "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" type: string WebPubSubTlsSettings: description: TLS settings for the resource type: object properties: clientCertEnabled: description: >- Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. default: false type: boolean parameters: ResourceName: in: path name: resourceName description: The name of the resource. required: true maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ type: string x-ms-parameter-location: method ReplicaName: in: path name: replicaName description: The name of the replica. required: true maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ type: string x-ms-parameter-location: method SharedPrivateLinkResourceName: in: path name: sharedPrivateLinkResourceName description: The name of the shared private link resource. required: true maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ type: string x-ms-parameter-location: method securityDefinitions: azure_auth: type: oauth2 flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account description: Azure Active Directory OAuth2 Flow security: - azure_auth: - user_impersonation host: management.azure.com schemes: - https produces: - application/json consumes: - application/json tags: - name: WebPubSub