Web Pub Sub - Check Name Availability

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

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability?api-version=2024-03-01

URI Parameters

Name In Required Type Description
location
path True

string

the region

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
name True

string

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

type True

string

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

Responses

Name Type Description
200 OK

NameAvailability

Success. The response describes the name availability.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

WebPubSub_CheckNameAvailability

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/checkNameAvailability?api-version=2024-03-01

{
  "type": "Microsoft.SignalRService/WebPubSub",
  "name": "myWebPubSubService"
}

Sample response

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "The name is already taken. Please try a different name."
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

NameAvailability

Result of the request to check name availability. It contains a flag and possible reason of failure.

NameAvailabilityParameters

Data POST-ed to the nameAvailability action

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

NameAvailability

Result of the request to check name availability. It contains a flag and possible reason of failure.

Name Type Description
message

string

The message of the operation.

nameAvailable

boolean

Indicates whether the name is available or not.

reason

string

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

NameAvailabilityParameters

Data POST-ed to the nameAvailability action

Name Type Description
name

string

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

type

string

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