Microsoft Azure Signal R Management Client is a powerful tool that allows developers to easily manage and monitor their Signal R applications on the Azure platform. With the Management Client, users can configure and scale their real-time web applications, monitor traffic and performance, and troubleshoot any issues that may arise.
swagger: '2.0'
info:
title: Microsoft Azure SignalRManagementClient
description: REST API for Azure SignalR Service
version: 2024-01-01-preview
paths:
/providers/Microsoft.SignalRService/operations:
get:
tags:
- SignalR
description: >-
Lists all of the available REST API operations of the
Microsoft.SignalRService provider.
operationId: microsoftAzureOperationsList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response describes the list of operations.
schema:
$ref: '#/definitions/OperationList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
summary: Microsoft Azure Get Providers Microsoft Signalrservice Operations
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability:
post:
tags:
- SignalR
description: Checks that the resource name is valid and is not already in use.
operationId: microsoftAzureSignalrChecknameavailability
produces:
- application/json
parameters:
- in: path
name: location
description: the region
required: true
type: string
- in: body
name: parameters
description: Parameters supplied to the operation.
required: true
schema:
$ref: '#/definitions/NameAvailabilityParameters'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Success. The response describes the name availability.
schema:
$ref: '#/definitions/NameAvailability'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalR_CheckNameAvailability:
$ref: ./examples/SignalR_CheckNameAvailability.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Checknameavailability
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages:
get:
tags:
- SignalR
description: List resource usage quotas by location.
operationId: microsoftAzureUsagesList
produces:
- application/json
parameters:
- in: path
name: location
description: the location like "eastus"
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: >-
Success. The response describe the usage quotas of a subscription in
specified region.
schema:
$ref: '#/definitions/SignalRUsageList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Usages_List:
$ref: ./examples/Usages_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Usages
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR:
get:
tags:
- SignalR
description: Handles requests to list all resources in a subscription.
operationId: microsoftAzureSignalrListbysubscription
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: >-
Success. The response describes the list of resources in the
subscription.
schema:
$ref: '#/definitions/SignalRResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
SignalR_ListBySubscription:
$ref: ./examples/SignalR_ListBySubscription.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Signalr
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR:
get:
tags:
- SignalR
description: Handles requests to list all resources in a resource group.
operationId: microsoftAzureSignalrListbyresourcegroup
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
responses:
'200':
description: >-
Success. The response describes the list of resources in a
resourceGroup.
schema:
$ref: '#/definitions/SignalRResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
SignalR_ListByResourceGroup:
$ref: ./examples/SignalR_ListByResourceGroup.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
: get:
tags:
- SignalR
description: Get the resource and its properties.
operationId: microsoftAzureSignalrGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response describes the corresponding resource.
schema:
$ref: '#/definitions/SignalRResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalR_Get:
$ref: ./examples/SignalR_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename
put:
tags:
- SignalR
description: Create or update a resource.
operationId: microsoftAzureSignalrCreateorupdate
produces:
- application/json
parameters:
- in: body
name: parameters
description: Parameters for the create or update operation
required: true
schema:
$ref: '#/definitions/SignalRResource'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response describes a resource.
schema:
$ref: '#/definitions/SignalRResource'
'201':
description: >-
Created. The response describes the new resource and contains a
Location header to query the operation result.
schema:
$ref: '#/definitions/SignalRResource'
'202':
description: >-
Accepted. The response indicates the exiting resource is now
updating and contains a Location header to query the operation
result..
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
SignalR_CreateOrUpdate:
$ref: ./examples/SignalR_CreateOrUpdate.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename
delete:
tags:
- SignalR
description: Operation to delete a resource.
operationId: microsoftAzureSignalrDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response indicates the resource is already deleted.
'202':
description: >-
Accepted. The response indicates the delete operation is performed
in the background.
'204':
description: Success. The response indicates the resource is already deleted.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
SignalR_Delete:
$ref: ./examples/SignalR_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename
patch:
tags:
- SignalR
description: Operation to update an exiting resource.
operationId: microsoftAzureSignalrUpdate
produces:
- application/json
parameters:
- in: body
name: parameters
description: Parameters for the update operation
required: true
schema:
$ref: '#/definitions/SignalRResource'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response describes a resource.
schema:
$ref: '#/definitions/SignalRResource'
'202':
description: >-
Accepted. The response indicates the exiting resource is now
updating and contains a Location header to query the operation
result..
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
SignalR_Update:
$ref: ./examples/SignalR_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates
: get:
tags:
- SignalR
description: List all custom certificates.
operationId: microsoftAzureSignalrcustomcertificatesList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response describes custom certificates of the resource.
schema:
$ref: '#/definitions/CustomCertificateList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
SignalRCustomCertificates_List:
$ref: ./examples/SignalRCustomCertificates_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customcertificates
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}
: get:
tags:
- SignalR
description: Get a custom certificate.
operationId: microsoftAzureSignalrcustomcertificatesGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: certificateName
description: Custom certificate name
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response describe the corresponding custom certificate.
schema:
$ref: '#/definitions/CustomCertificate'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalRCustomCertificates_Get:
$ref: ./examples/SignalRCustomCertificates_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customcertificates Certificatename
put:
tags:
- SignalR
description: Create or update a custom certificate.
operationId: microsoftAzureSignalrcustomcertificatesCreateorupdate
consumes:
- application/json
- text/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: certificateName
description: Custom certificate name
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: ''
required: true
schema:
$ref: '#/definitions/CustomCertificate'
responses:
'200':
description: Success. The response describes the certificate.
schema:
$ref: '#/definitions/CustomCertificate'
'201':
description: Created. The response describes the certificate.
schema:
$ref: '#/definitions/CustomCertificate'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
SignalRCustomCertificates_CreateOrUpdate:
$ref: ./examples/SignalRCustomCertificates_CreateOrUpdate.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customcertificates Certificatename
delete:
tags:
- SignalR
description: Delete a custom certificate.
operationId: microsoftAzureSignalrcustomcertificatesDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: certificateName
description: Custom certificate name
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success.
'204':
description: No Content.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalRCustomCertificates_Delete:
$ref: ./examples/SignalRCustomCertificates_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customcertificates Certificatename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains
: get:
tags:
- SignalR
description: List all custom domains.
operationId: microsoftAzureSignalrcustomdomainsList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response describes custom domains of the resource.
schema:
$ref: '#/definitions/CustomDomainList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
SignalRCustomDomains_List:
$ref: ./examples/SignalRCustomDomains_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customdomains
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}
: get:
tags:
- SignalR
description: Get a custom domain.
operationId: microsoftAzureSignalrcustomdomainsGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: name
description: Custom domain name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response describe the corresponding custom domain.
schema:
$ref: '#/definitions/CustomDomain'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalRCustomDomains_Get:
$ref: ./examples/SignalRCustomDomains_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customdomains Name
put:
tags:
- SignalR
description: Create or update a custom domain.
operationId: microsoftAzureSignalrcustomdomainsCreateorupdate
consumes:
- application/json
- text/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: name
description: Custom domain name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: ''
required: true
schema:
$ref: '#/definitions/CustomDomain'
responses:
'201':
description: >-
Created. The response describes the custom domain and contains a
Location header to query the operation result.
schema:
$ref: '#/definitions/CustomDomain'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
SignalRCustomDomains_CreateOrUpdate:
$ref: ./examples/SignalRCustomDomains_CreateOrUpdate.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customdomains Name
delete:
tags:
- SignalR
description: Delete a custom domain.
operationId: microsoftAzureSignalrcustomdomainsDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
- in: path
name: name
description: Custom domain name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success. The response indicates the custom domain is deleted.
'202':
description: >-
Accepted. The response indicates the operation is performed in the
background.
'204':
description: Success. The response indicates the custom domain is deleted.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
SignalRCustomDomains_Delete:
$ref: ./examples/SignalRCustomDomains_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Customdomains Name
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys
: post:
tags:
- SignalR
description: Get the access keys of the resource.
operationId: microsoftAzureSignalrListkeys
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response describes access keys of the resource.
schema:
$ref: '#/definitions/SignalRKeys'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalR_ListKeys:
$ref: ./examples/SignalR_ListKeys.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Listkeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections
: get:
tags:
- SignalR
description: List private endpoint connections
operationId: microsoftAzureSignalrprivateendpointconnectionsList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: >-
Success. The response describes a list of private endpoint
connections.
schema:
$ref: '#/definitions/PrivateEndpointConnectionList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
SignalRPrivateEndpointConnections_List:
$ref: ./examples/SignalRPrivateEndpointConnections_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Privateendpointconnections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- SignalR
description: Get the specified private endpoint connection
operationId: microsoftAzureSignalrprivateendpointconnectionsGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v4/privatelinks.json#/parameters/PrivateEndpointConnectionName
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ResourceName'
responses:
'200':
description: Success. The response describes a private endpoint connection.
schema:
$ref: '#/definitions/PrivateEndpointConnection'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SignalRPrivateEndpointConnections_Get:
$ref: ./examples/SignalRPrivateEndpointConnections_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Signalr Resourcename Privateendpointconnections Privateendpointconnectionname
put:
tags:
- SignalR
description: Update the state of spe
# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/signalrmanagementclient-openapi-original.yml