openapi: 3.2.0 info: title: Microsoft Azure Webpubsub API version: '1.0' description: 'Operations tagged Webpubsub across 2 of this provider''s published API definitions: azure-web-pubsub-service-rest-api-openapi-original.yml, webpubsubmanagementclient-openapi-original.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://management.azure.com tags: - name: Web Pub Sub paths: /api/hubs/{hub}/:generateToken: post: tags: - Web Pub Sub summary: Microsoft Azure Generate Token For The Client To Connect Azure Web Pubsub… operationId: microsoftAzureWebpubsubGenerateclienttoken parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: query name: userId description: User Id. schema: type: string default: '' - in: query name: role description: Roles that the connection with the generated token will have. style: form explode: true schema: type: array items: type: string - in: query name: minutesToExpire description: The expire time of the generated token. schema: type: integer format: int32 default: 60 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ClientTokenResponse' application/json: schema: $ref: '#/components/schemas/ClientTokenResponse' text/json: schema: $ref: '#/components/schemas/ClientTokenResponse' default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/:send: post: tags: - Web Pub Sub summary: Microsoft Azure Broadcast Content Inside Request Body To All The Connected… operationId: microsoftAzureWebpubsubSendtoall parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: query name: excluded description: Excluded connection Ids. style: form explode: true schema: type: array items: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '202': description: The message is accepted. The service follows fire-and-forget pattern when sending messages. default: description: Error response x-ms-error-response: true description: Needs a more full description created. requestBody: content: application/octet-stream: schema: format: binary type: string text/plain: schema: format: binary type: string application/json: schema: format: binary type: string description: The payload body. required: true /api/hubs/{hub}/connections/{connectionId}: head: tags: - Web Pub Sub summary: Microsoft Azure Check If The Connection With The Given Connectionid Exists operationId: microsoftAzureWebpubsubConnectionexists parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: connectionId description: The connection Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. delete: tags: - Web Pub Sub summary: Microsoft Azure Close The Client Connection operationId: microsoftAzureWebpubsubCloseconnection parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: connectionId description: Target connection Id. required: true schema: type: string minLength: 1 - in: query name: reason description: The reason closing the client connection. schema: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/connections/{connectionId}/:send: post: tags: - Web Pub Sub summary: Microsoft Azure Send Content Inside Request Body To The Specific Connection operationId: microsoftAzureWebpubsubSendtoconnection parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: connectionId description: The connection Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '202': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. requestBody: content: application/octet-stream: schema: format: binary type: string text/plain: schema: format: binary type: string application/json: schema: format: binary type: string description: The payload body. required: true /api/hubs/{hub}/groups/{group}: head: tags: - Web Pub Sub summary: Microsoft Azure Check If There Are Any Client Connections Inside The Given Group operationId: microsoftAzureWebpubsubGroupexists parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/groups/{group}/:send: post: tags: - Web Pub Sub summary: Microsoft Azure Send Content Inside Request Body To A Group Of Connections operationId: microsoftAzureWebpubsubSendtogroup parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: query name: excluded description: Excluded connection Ids style: form explode: true schema: type: array items: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '202': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. requestBody: content: application/octet-stream: schema: format: binary type: string text/plain: schema: format: binary type: string application/json: schema: format: binary type: string description: The payload body. required: true /api/hubs/{hub}/groups/{group}/connections/{connectionId}: put: tags: - Web Pub Sub summary: Microsoft Azure Add A Connection To The Target Group operationId: microsoftAzureWebpubsubAddconnectiontogroup parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: path name: connectionId description: Target connection Id required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. delete: tags: - Web Pub Sub summary: Microsoft Azure Remove A Connection From The Target Group operationId: microsoftAzureWebpubsubRemoveconnectionfromgroup parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: path name: connectionId description: Target connection Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/users/{userId}: head: tags: - Web Pub Sub summary: Microsoft Azure Check If There Are Any Client Connections Connected For The… operationId: microsoftAzureWebpubsubUserexists parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: userId description: Target user Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/users/{userId}/:send: post: tags: - Web Pub Sub summary: Microsoft Azure Send Content Inside Request Body To The Specific User operationId: microsoftAzureWebpubsubSendtouser parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: userId description: The user Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '202': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. requestBody: content: application/octet-stream: schema: format: binary type: string text/plain: schema: format: binary type: string application/json: schema: format: binary type: string description: The payload body. required: true /api/hubs/{hub}/users/{userId}/groups/{group}: put: tags: - Web Pub Sub summary: Microsoft Azure Add A User To The Target Group operationId: microsoftAzureWebpubsubAddusertogroup parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: path name: userId description: Target user Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. delete: tags: - Web Pub Sub summary: Microsoft Azure Remove A User From The Target Group operationId: microsoftAzureWebpubsubRemoveuserfromgroup parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: group description: Target group name, which length should be greater than 0 and less than 1025. required: true schema: type: string maxLength: 1024 minLength: 1 - in: path name: userId description: Target user Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/users/{userId}/groups: delete: tags: - Web Pub Sub summary: Microsoft Azure Remove A User From All Groups operationId: microsoftAzureWebpubsubRemoveuserfromallgroups parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: userId description: Target user Id. required: true schema: type: string minLength: 1 - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: The user is deleted. default: description: Error response x-ms-error-response: true description: Needs a more full description created. /api/hubs/{hub}/permissions/{permission}/connections/{connectionId}: put: tags: - Web Pub Sub summary: Microsoft Azure Grant Permission To The Connection operationId: microsoftAzureWebpubsubGrantpermission parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: permission description: 'The permission: current supported actions are joinLeaveGroup and sendToGroup.' required: true x-ms-enum: name: WebPubSubPermission modelAsString: true schema: type: string enum: - sendToGroup - joinLeaveGroup - in: path name: connectionId description: Target connection Id. required: true schema: type: string minLength: 1 - in: query name: targetName description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. schema: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. delete: tags: - Web Pub Sub summary: Microsoft Azure Revoke Permission For The Connection operationId: microsoftAzureWebpubsubRevokepermission parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: permission description: 'The permission: current supported actions are joinLeaveGroup and sendToGroup.' required: true x-ms-enum: name: WebPubSubPermission modelAsString: true schema: type: string enum: - sendToGroup - joinLeaveGroup - in: path name: connectionId description: Target connection Id. required: true schema: type: string minLength: 1 - in: query name: targetName description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. schema: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success default: description: Error response x-ms-error-response: true description: Needs a more full description created. head: tags: - Web Pub Sub summary: Microsoft Azure Check If A Connection Has Permission To The Specified Action operationId: microsoftAzureWebpubsubCheckpermission parameters: - in: path name: hub description: Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. required: true schema: type: string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ - in: path name: permission description: 'The permission: current supported actions are joinLeaveGroup and sendToGroup.' required: true x-ms-enum: name: WebPubSubPermission modelAsString: true schema: type: string enum: - sendToGroup - joinLeaveGroup - in: path name: connectionId description: Target connection Id. required: true schema: type: string minLength: 1 - in: query name: targetName description: The meaning of the target depends on the specific permission. For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name. schema: type: string - in: query name: api-version description: The version of the REST APIs. schema: type: string default: 2021-05-01-preview responses: '200': description: Success '404': description: Not Found default: description: Error response x-ms-error-response: true description: Needs a more full description created. /providers/Microsoft.SignalRService/operations: get: tags: - Web Pub Sub description: Lists all of the available REST API operations of the Microsoft.SignalRService provider. operationId: microsoftAzureOperationsList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes the list of operations. content: application/json: schema: $ref: '#/components/schemas/OperationList' default: description: Error response describing why the operation failed. content: application/json: 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 security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability: post: tags: - Web Pub Sub description: Checks that the resource name is valid and is not already in use. operationId: microsoftAzureWebpubsubChecknameavailability parameters: - in: path name: location description: the region required: true schema: 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 describes the name availability. content: application/json: schema: $ref: '#/components/schemas/NameAvailability' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/NameAvailabilityParameters' description: Parameters supplied to the operation. required: true security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages: get: tags: - Web Pub Sub description: List resource usage quotas by location. operationId: microsoftAzureUsagesList parameters: - in: path name: location description: the location like "eastus" required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/SignalRServiceUsageList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub: get: tags: - Web Pub Sub description: Handles requests to list all resources in a subscription. operationId: microsoftAzureWebpubsubListbysubscription 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. content: application/json: schema: $ref: '#/components/schemas/WebPubSubResourceList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub: get: tags: - Web Pub Sub description: Handles requests to list all resources in a resource group. operationId: microsoftAzureWebpubsubListbyresourcegroup 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. content: application/json: schema: $ref: '#/components/schemas/WebPubSubResourceList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} : get: tags: - Web Pub Sub description: Get the resource and its properties. operationId: microsoftAzureWebpubsubGet 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes the corresponding resource. content: application/json: schema: $ref: '#/components/schemas/WebPubSubResource' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a resource. operationId: microsoftAzureWebpubsubCreateorupdate 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a resource. content: application/json: schema: $ref: '#/components/schemas/WebPubSubResource' '201': description: Created. The response describes the new resource and contains a Location header to query the operation result. content: application/json: schema: $ref: '#/components/schemas/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. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/WebPubSubResource' description: Parameters for the create or update operation required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub 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: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation patch: tags: - Web Pub Sub description: Operation to update an exiting resource. operationId: microsoftAzureWebpubsubUpdate 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a resource. content: application/json: schema: $ref: '#/components/schemas/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: schema: type: string default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/WebPubSubResource' description: Parameters for the update operation required: true security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates : get: tags: - Web Pub Sub description: List all custom certificates. operationId: microsoftAzureWebpubsubcustomcertificatesList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes custom certificates of the resource. content: application/json: schema: $ref: '#/components/schemas/CustomCertificateList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName} : get: tags: - Web Pub Sub description: Get a custom certificate. operationId: microsoftAzureWebpubsubcustomcertificatesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describe the corresponding custom certificate. content: application/json: schema: $ref: '#/components/schemas/CustomCertificate' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a custom certificate. operationId: microsoftAzureWebpubsubcustomcertificatesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes the certificate. content: application/json: schema: $ref: '#/components/schemas/CustomCertificate' '201': description: Created. The response describes the certificate. content: application/json: schema: $ref: '#/components/schemas/CustomCertificate' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomCertificate' text/json: schema: $ref: '#/components/schemas/CustomCertificate' required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub 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: '#/components/parameters/ResourceName' - in: path name: certificateName description: Custom certificate name required: true schema: 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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains : get: tags: - Web Pub Sub description: List all custom domains. operationId: microsoftAzureWebpubsubcustomdomainsList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes custom domains of the resource. content: application/json: schema: $ref: '#/components/schemas/CustomDomainList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name} : get: tags: - Web Pub Sub description: Get a custom domain. operationId: microsoftAzureWebpubsubcustomdomainsGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describe the corresponding custom domain. content: application/json: schema: $ref: '#/components/schemas/CustomDomain' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a custom domain. operationId: microsoftAzureWebpubsubcustomdomainsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '201': description: Created. The response describes the custom domain and contains a Location header to query the operation result. content: application/json: schema: $ref: '#/components/schemas/CustomDomain' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomDomain' text/json: schema: $ref: '#/components/schemas/CustomDomain' required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub 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: '#/components/parameters/ResourceName' - in: path name: name description: Custom domain name. required: true schema: 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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs : get: tags: - Web Pub Sub description: List hub settings. operationId: microsoftAzureWebpubsubhubsList 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes hub settings of the resource. content: application/json: schema: $ref: '#/components/schemas/WebPubSubHubList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName} : get: tags: - Web Pub Sub description: Get a hub setting. operationId: microsoftAzureWebpubsubhubsGet parameters: - in: path name: hubName description: The hub name. required: true schema: 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describe the corresponding hub setting. content: application/json: schema: $ref: '#/components/schemas/WebPubSubHub' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a hub setting. operationId: microsoftAzureWebpubsubhubsCreateorupdate parameters: - in: path name: hubName description: The hub name. required: true schema: 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: '#/components/parameters/ResourceName' responses: '200': description: OK.The request makes no change. The response describes the existing hub setting. content: application/json: schema: $ref: '#/components/schemas/WebPubSubHub' '201': description: Created. The response describes the hub setting and contains a Location header to query the operation result. content: application/json: schema: $ref: '#/components/schemas/WebPubSubHub' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/WebPubSubHub' description: The resource of WebPubSubHub and its properties required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub description: Delete a hub setting. operationId: microsoftAzureWebpubsubhubsDelete parameters: - in: path name: hubName description: The hub name. required: true schema: 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: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys : post: tags: - Web Pub Sub description: Get the access keys of the resource. operationId: microsoftAzureWebpubsubListkeys 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes access keys of the resource. content: application/json: schema: $ref: '#/components/schemas/WebPubSubKeys' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections : get: tags: - Web Pub Sub description: List private endpoint connections operationId: microsoftAzureWebpubsubprivateendpointconnectionsList 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a list of private endpoint connections. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Web Pub Sub description: Get the specified private endpoint connection operationId: microsoftAzureWebpubsubprivateendpointconnectionsGet 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a private endpoint connection. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Update the state of specified private endpoint connection operationId: microsoftAzureWebpubsubprivateendpointconnectionsUpdate 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: '#/components/parameters/ResourceName' responses: '200': description: OK. The response indicates the private endpoint connection is updated successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' description: The resource of private endpoint and its properties required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub 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: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources : get: tags: - Web Pub Sub description: Get the private link resources that need to be created for a resource. operationId: microsoftAzureWebpubsubprivatelinkresourcesList 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a list of private link resources. content: application/json: schema: $ref: '#/components/schemas/PrivateLinkResourceList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey : post: tags: - Web Pub Sub description: Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time. operationId: microsoftAzureWebpubsubRegeneratekey 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: '#/components/parameters/ResourceName' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/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. headers: Location: schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebPubSubKeys' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/RegenerateKeyParameters' description: Parameter that describes the Regenerate Key Operation. required: true security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas : get: tags: - Web Pub Sub description: List all replicas belong to this resource operationId: microsoftAzureWebpubsubreplicasList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes replicas of the resource. content: application/json: schema: $ref: '#/components/schemas/ReplicaList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} : get: tags: - Web Pub Sub description: Get the replica and its properties. operationId: microsoftAzureWebpubsubreplicasGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/parameters/ReplicaName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes the corresponding replica. content: application/json: schema: $ref: '#/components/schemas/Replica' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a replica. operationId: microsoftAzureWebpubsubreplicasCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/parameters/ReplicaName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Updated. The response describes a replica. content: application/json: schema: $ref: '#/components/schemas/Replica' '201': description: Created. The response describes the new replica and contains a Location header to query the operation result. content: application/json: schema: $ref: '#/components/schemas/Replica' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/Replica' text/json: schema: $ref: '#/components/schemas/Replica' description: Parameters for the create or update operation required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub 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: '#/components/parameters/ResourceName' - $ref: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation patch: tags: - Web Pub Sub description: Operation to update an exiting replica. operationId: microsoftAzureWebpubsubreplicasUpdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/parameters/ReplicaName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes a replica. content: application/json: schema: $ref: '#/components/schemas/Replica' '202': description: Updated. The response describes the new replica and contains a Location header to query the operation result. headers: Location: schema: type: string content: application/json: schema: $ref: '#/components/schemas/Replica' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/Replica' text/json: schema: $ref: '#/components/schemas/Replica' description: Parameters for the update operation required: true security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart : post: tags: - Web Pub Sub 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: '#/components/parameters/ResourceName' - $ref: '#/components/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: schema: 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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources : get: tags: - Web Pub Sub description: List shared private link resources operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/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. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResourceList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : get: tags: - Web Pub Sub description: Get the specified shared private link resource operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesGet parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/parameters/ReplicaName' - $ref: '#/components/parameters/SharedPrivateLinkResourceName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success. The response describes a shared private link resource. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a shared private link resource operationId: microsoftAzureWebpubsubreplicasharedprivatelinkresourcesCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/parameters/ReplicaName' - $ref: '#/components/parameters/SharedPrivateLinkResourceName' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The response indicates the shared private link resource is updated. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' '201': description: Created. The response indicates the shared private link resource is created. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' text/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' description: The shared private link resource required: true security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus : get: tags: - Web Pub Sub description: List all available skus of the replica resource. operationId: microsoftAzureWebpubsubListreplicaskus parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ResourceName' - $ref: '#/components/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. content: application/json: schema: $ref: '#/components/schemas/SkuList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart : post: tags: - Web Pub Sub 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: '#/components/parameters/ResourceName' responses: '202': description: Accepted. The response indicates the restart operation is performed in the background. headers: Location: schema: 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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources : get: tags: - Web Pub Sub description: List shared private link resources operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesList 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a list of shared private link resources. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResourceList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : get: tags: - Web Pub Sub description: Get the specified shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesGet parameters: - $ref: '#/components/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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes a shared private link resource. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation put: tags: - Web Pub Sub description: Create or update a shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesCreateorupdate parameters: - $ref: '#/components/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: '#/components/parameters/ResourceName' responses: '200': description: OK. The response indicates the shared private link resource is updated. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' '201': description: Created. The response indicates the shared private link resource is created. content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/SharedPrivateLinkResource' description: The shared private link resource required: true security: - azure_auth: - user_impersonation delete: tags: - Web Pub Sub description: Delete the specified shared private link resource operationId: microsoftAzureWebpubsubsharedprivatelinkresourcesDelete parameters: - $ref: '#/components/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: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus : get: tags: - Web Pub Sub description: List all available skus of the resource. operationId: microsoftAzureWebpubsubListskus 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: '#/components/parameters/ResourceName' responses: '200': description: Success. The response describes all available skus of the resource. content: application/json: schema: $ref: '#/components/schemas/SkuList' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com components: schemas: ClientTokenResponse: type: object properties: token: type: string 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. For 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.\nThere are 3 kinds of patterns supported:\n 1. \"*\", it matches any event name\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\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: '#/components/schemas/UpstreamAuthSettings' 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. \nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted." 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: '#/components/schemas/Dimension' x-ms-identifiers: - name 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: '#/components/schemas/SignalRServiceUsageName' unit: description: 'Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.' 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 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 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: propertyName: type ServiceKind: description: The kind of the service enum: - WebPubSub - SocketIO type: string x-ms-enum: name: ServiceKind modelAsString: true UpstreamAuthSettings: description: Upstream auth settings. If not set, no auth is used for upstream messages. type: object properties: type: $ref: '#/components/schemas/UpstreamAuthType' managedIdentity: $ref: '#/components/schemas/ManagedIdentitySettings' 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 ManagedIdentitySettings: description: Managed identity settings for upstream. type: object properties: resource: description: 'The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.' type: string 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: '#/components/schemas/PrivateLinkResourceProperties' WebPubSubSocketIOSettings: description: SocketIO settings for the resource type: object properties: serviceMode: description: "The service mode of Web PubSub for Socket.IO. Values allowed: \n\"Default\": have your own backend Socket.IO server\n\"Serverless\": your application doesn't have a backend server" type: string EventListener: description: A setting defines which kinds of events should be sent to which endpoint. required: - endpoint - filter type: object properties: filter: $ref: '#/components/schemas/EventListenerFilter' endpoint: $ref: '#/components/schemas/EventListenerEndpoint' 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: '#/components/schemas/PrivateEndpointConnectionProperties' 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: '#/components/schemas/ShareablePrivateLinkResourceType' x-ms-identifiers: [] 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 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 CustomCertificateProperties: description: Custom certificate properties. required: - keyVaultBaseUri - keyVaultSecretName type: object properties: provisioningState: readOnly: true $ref: '#/components/schemas/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 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 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: '#/components/schemas/SignalRServiceUsage' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string ACLAction: description: Azure Networking ACL Action. enum: - Allow - Deny type: string x-ms-enum: name: ACLAction modelAsString: true ScaleType: description: The scale type applicable to the sku. enum: - None - Manual - Automatic type: string x-ms-enum: name: ScaleType modelAsString: true LiveTraceConfiguration: description: Live trace configuration of a Microsoft.SignalRService resource. type: object properties: enabled: description: 'Indicates whether or not enable live trace. When it''s set to true, live trace client can connect to the service. Otherwise, live trace client can''t connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.' default: 'false' type: string categories: description: Gets or sets the list of category configurations. type: array items: $ref: '#/components/schemas/LiveTraceCategory' x-ms-identifiers: - name ReplicaList: type: object properties: value: description: List of the replica type: array items: $ref: '#/components/schemas/Replica' nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string 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. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.' type: string enabled: description: 'Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.' type: string WebPubSubProperties: description: A class that describes the properties of the resource type: object properties: provisioningState: readOnly: true $ref: '#/components/schemas/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: '#/components/schemas/PrivateEndpointConnection' readOnly: true x-ms-identifiers: [] sharedPrivateLinkResources: description: The list of shared private link resources. type: array items: $ref: '#/components/schemas/SharedPrivateLinkResource' readOnly: true x-ms-identifiers: [] tls: $ref: '#/components/schemas/WebPubSubTlsSettings' hostNamePrefix: description: Deprecated. type: string readOnly: true liveTraceConfiguration: $ref: '#/components/schemas/LiveTraceConfiguration' resourceLogConfiguration: $ref: '#/components/schemas/ResourceLogConfiguration' networkACLs: $ref: '#/components/schemas/WebPubSubNetworkACLs' publicNetworkAccess: description: 'Enable or disable public network access. Default to "Enabled". When it''s Enabled, network ACLs still apply. When it''s Disabled, public network access is always disabled no matter what you set in network ACLs.' default: Enabled type: string disableLocalAuth: description: 'DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won''t work.' default: false type: boolean disableAadAuth: description: 'DisableLocalAuth Enable or disable aad auth When 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". When it''s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.' default: Enabled type: string resourceStopped: description: 'Stop or start the resource. Default to "False". When it''s true, the data plane of the resource is shutdown. When it''s false, the data plane of the resource is started.' default: 'false' type: string socketIO: $ref: '#/components/schemas/WebPubSubSocketIOSettings' WebPubSubHub: description: A hub setting required: - properties type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/components/schemas/WebPubSubHubProperties' SharedPrivateLinkResourceStatus: description: Status of the shared private link resource enum: - Pending - Approved - Rejected - Disconnected - Timeout type: string x-ms-enum: name: SharedPrivateLinkResourceStatus modelAsString: true 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 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: '#/components/schemas/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 WebPubSubHubProperties: description: Properties of a hub. type: object properties: eventHandlers: description: Event handler of a hub. type: array items: $ref: '#/components/schemas/EventHandler' x-ms-identifiers: [] eventListeners: description: 'Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn''t return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn''t matter. Maximum count of event listeners among all hubs is 10.' type: array items: $ref: '#/components/schemas/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 WebPubSubResource: description: A class represent a resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: sku: $ref: '#/components/schemas/ResourceSku' properties: x-ms-client-flatten: true $ref: '#/components/schemas/WebPubSubProperties' kind: x-ms-mutability: - read - create $ref: '#/components/schemas/ServiceKind' identity: $ref: '#/components/schemas/ManagedIdentity' 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: '#/components/schemas/CustomDomainProperties' ReplicaProperties: type: object properties: provisioningState: readOnly: true $ref: '#/components/schemas/ProvisioningState' regionEndpointEnabled: description: 'Enable or disable the regional endpoint. Default to "Enabled". When it''s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.' default: Enabled type: string resourceStopped: description: 'Stop or start the resource. Default to "false". When it''s true, the data plane of the resource is shutdown. When it''s false, the data plane of the resource is started.' default: 'false' type: string ManagedIdentityType: description: 'Represents the identity type: systemAssigned, userAssigned, None' enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: name: ManagedIdentityType modelAsString: true WebPubSubRequestType: description: The incoming request type to the service enum: - ClientConnection - ServerConnection - RESTAPI - Trace type: string x-ms-enum: name: WebPubSubRequestType modelAsString: true 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 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 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: '#/components/schemas/CustomCertificateProperties' WebPubSubHubList: description: Hub setting list type: object properties: value: description: List of hub settings to this resource. type: array items: $ref: '#/components/schemas/WebPubSubHub' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string readOnly: true 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: '#/components/schemas/WebPubSubResource' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string CustomCertificateList: description: Custom certificates list. type: object properties: value: description: List of custom certificates of this resource. type: array items: $ref: '#/components/schemas/CustomCertificate' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' 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: '#/components/schemas/ResourceLogCategory' x-ms-identifiers: - name UpstreamAuthType: description: Upstream auth type enum. enum: - None - ManagedIdentity type: string x-ms-enum: name: UpstreamAuthType modelAsString: true ResourceReference: description: Reference to a resource. type: object properties: id: description: Resource ID. type: string IPRule: description: An IP rule type: object properties: value: description: An IP or CIDR or ServiceTag type: string action: $ref: '#/components/schemas/ACLAction' 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. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.' type: string enabled: description: 'Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.' type: string ManagedIdentity: description: A class represent managed identities used for request and response type: object properties: type: $ref: '#/components/schemas/ManagedIdentityType' userAssignedIdentities: description: Get or set the user assigned identities type: object additionalProperties: $ref: '#/components/schemas/UserAssignedIdentityProperty' principalId: description: 'Get the principal id for the system assigned identity. Only be used in response.' type: string readOnly: true tenantId: description: 'Get the tenant id for the system assigned identity. Only be used in response' type: string readOnly: true PrivateEndpointConnectionProperties: description: Private endpoint connection properties type: object properties: provisioningState: readOnly: true $ref: '#/components/schemas/ProvisioningState' privateEndpoint: $ref: '#/components/schemas/PrivateEndpoint' groupIds: description: Group IDs type: array items: type: string readOnly: true x-ms-identifiers: [] privateLinkServiceConnectionState: $ref: '#/components/schemas/PrivateLinkServiceConnectionState' 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: '#/components/schemas/PrivateLinkResource' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string ResourceSku: description: The billing information of the resource. required: - name type: object properties: name: description: 'The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2' type: string tier: $ref: '#/components/schemas/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.\n1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default.\n\nIf present, following values are allowed:\n Free_F1: 1;\n Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\n Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\n Premium_P2: 100,200,300,400,500,600,700,800,900,1000;" type: integer CustomDomainProperties: description: Properties of a custom domain. required: - customCertificate - domainName type: object properties: provisioningState: readOnly: true $ref: '#/components/schemas/ProvisioningState' domainName: description: The custom domain name. type: string customCertificate: $ref: '#/components/schemas/ResourceReference' 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 SkuList: description: The list skus operation response type: object properties: value: description: The list of skus available for the resource. type: array items: $ref: '#/components/schemas/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). It''s null for now, added for future use.' type: string readOnly: true 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 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: '#/components/schemas/SharedPrivateLinkResourceProperties' 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: '#/components/schemas/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: '#/components/schemas/OperationProperties' OperationProperties: description: Extra Operation properties. type: object properties: serviceSpecification: $ref: '#/components/schemas/ServiceSpecification' KeyType: description: The type of access key. enum: - Primary - Secondary - Salt type: string x-ms-enum: name: KeyType modelAsString: true PrivateEndpoint: description: Private endpoint type: object properties: id: description: Full qualified Id of the private endpoint 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: '#/components/schemas/ProvisioningState' requestMessage: description: The request message for requesting approval of the shared private link resource type: string status: readOnly: true $ref: '#/components/schemas/SharedPrivateLinkResourceStatus' ServiceSpecification: description: An object that describes a specification. type: object properties: metricSpecifications: description: Specifications of the Metrics for Azure Monitoring. type: array items: $ref: '#/components/schemas/MetricSpecification' x-ms-identifiers: - name - unit logSpecifications: description: Specifications of the Logs for Azure Monitoring. type: array items: $ref: '#/components/schemas/LogSpecification' x-ms-identifiers: - name WebPubSubNetworkACLs: description: Network ACLs for the resource type: object properties: defaultAction: $ref: '#/components/schemas/ACLAction' publicNetwork: $ref: '#/components/schemas/NetworkACL' privateEndpoints: description: ACLs for requests from private endpoints type: array items: $ref: '#/components/schemas/PrivateEndpointACL' x-ms-identifiers: - name ipRules: description: IP rules for filtering public traffic maxItems: 30 type: array items: $ref: '#/components/schemas/IPRule' x-ms-identifiers: [] CustomDomainList: description: Custom domains list type: object properties: value: description: List of custom domains that bind to this resource. type: array items: $ref: '#/components/schemas/CustomDomain' x-ms-identifiers: [] nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string Replica: description: A class represent a replica resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: sku: $ref: '#/components/schemas/ResourceSku' properties: x-ms-client-flatten: true $ref: '#/components/schemas/ReplicaProperties' 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: '#/components/schemas/ScaleType' PrivateEndpointConnectionList: description: A list of private endpoint connections type: object properties: value: description: The list of the private endpoint connections type: array items: $ref: '#/components/schemas/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 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: '#/components/schemas/ResourceSku' capacity: readOnly: true $ref: '#/components/schemas/SkuCapacity' 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: '#/components/schemas/ShareablePrivateLinkResourceProperties' 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 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: '#/components/schemas/WebPubSubRequestType' x-ms-identifiers: [] deny: description: 'Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.' type: array items: $ref: '#/components/schemas/WebPubSubRequestType' x-ms-identifiers: [] WebPubSubSkuTier: description: "Optional tier of this particular SKU. 'Standard' or 'Free'. \n\n`Basic` is deprecated, use `Standard` instead." enum: - Free - Basic - Standard - Premium type: string x-ms-enum: name: WebPubSubSkuTier modelAsString: true PrivateEndpointACL: description: ACL for a private endpoint required: - name type: object allOf: - $ref: '#/components/schemas/NetworkACL' properties: name: description: Name of the private endpoint connection type: string 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: propertyName: type RegenerateKeyParameters: description: Parameters describes the request to regenerate access keys type: object properties: keyType: $ref: '#/components/schemas/KeyType' PrivateLinkServiceConnectionState: description: Connection state of the private endpoint connection type: object properties: status: $ref: '#/components/schemas/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 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: '#/components/schemas/Operation' x-ms-identifiers: - name nextLink: description: 'The URL the client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' type: string parameters: ResourceName: in: path name: resourceName description: The name of the resource. required: true x-ms-parameter-location: method schema: type: string maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ SharedPrivateLinkResourceName: in: path name: sharedPrivateLinkResourceName description: The name of the shared private link resource. required: true x-ms-parameter-location: method schema: type: string maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ ReplicaName: in: path name: replicaName description: The name of the replica. required: true x-ms-parameter-location: method schema: type: string maxLength: 63 minLength: 3 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ securitySchemes: azure_auth: type: oauth2 flows: implicit: scopes: user_impersonation: impersonate your user account authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize description: Azure Active Directory OAuth2 Flow x-refined-from: - azure-web-pubsub-service-rest-api-openapi-original.yml - webpubsubmanagementclient-openapi-original.yml x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/components/parameters/Endpoint'