Sign in
SignalR

Checks that the resource name is valid and is not already in use.

post/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability

Path parameters

locationstring required

the region

Parameters

../../../../../../common-types/resource-management/v5/types.json#/components/parameters/ApiVersionParameter — unresolved $ref
../../../../../../common-types/resource-management/v5/types.json#/components/parameters/SubscriptionIdParameter — unresolved $ref

Request body

typestring required

The resource type. Can be "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" or "Microsoft.SignalRService/WebPubSub/replicas"

namestring required

The resource name to validate. e.g."my-resource-name"

Response

Success. The response describes the name availability.

nameAvailableboolean

Indicates whether the name is available or not.

reasonstring

The reason of the availability. Required if name is not available.

messagestring

The message of the operation.