Sign in
Proxy

Check if a service instance name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability

Parameters

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

Request body

namestring required

The name of the service instance to check.

typestring required

The fully qualified resource type which includes provider namespace.

Response

This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.

nameAvailableboolean

The value which indicates whether the provided name is available.

reason'Invalid' | 'AlreadyExists'

The reason for unavailability.

messagestring

The detailed reason message.