The Microsoft Azure Web Pub Sub Management Client is a tool that allows users to easily manage and monitor their Web Pub Sub service on the Azure cloud platform. With this client, users can create, update, and delete instances of the Web Pub Sub service, as well as configure settings, view metrics, and troubleshoot any issues that may arise.
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-o
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/webpubsubmanagementclient-openapi-original.yml