Share via

Services - Check Name Availability

Service:
Healthcare Apis
API Version:
2022-06-01

Check if a service instance name is available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability?api-version=2022-06-01

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

Client Api Version.

Request Body

Name Required Type Description
name True

string

The name of the service instance to check.
type True

string

The fully qualified resource type which includes provider namespace.

Responses

Name Type Description
200 OK

ServicesNameAvailabilityInfo

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.
Other Status Codes

ErrorDetails

DefaultErrorResponse

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

Check name availability

Sample request

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.HealthcareApis/checkNameAvailability?api-version=2022-06-01

{
  "type": "Microsoft.HealthcareApis/services",
  "name": "serviceName"
}

Sample response

Status code:
200 
{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Service name is not available."
}

Definitions

Name Description
CheckNameAvailabilityParameters

Input values.
ErrorDetails

Error details.
ErrorDetailsInternal

Error details.
ServiceNameUnavailabilityReason

The reason for unavailability.
ServicesNameAvailabilityInfo

The properties indicating whether a given service name is available.

CheckNameAvailabilityParameters

Object

Input values.

Name Type Description
name

string

The name of the service instance to check.
type

string

The fully qualified resource type which includes provider namespace.

ErrorDetails

Object

Error details.

Name Type Description
error

ErrorDetailsInternal

Error details

ErrorDetailsInternal

Object

Error details.

Name Type Description
code

string

The error code.
message

string

The error message.
target

string

The target of the particular error.

ServiceNameUnavailabilityReason

Enumeration

The reason for unavailability.

Value Description
Invalid
AlreadyExists

ServicesNameAvailabilityInfo

Object

The properties indicating whether a given service name is available.

Name Type Description
message

string

The detailed reason message.
nameAvailable

boolean

The value which indicates whether the provided name is available.
reason

ServiceNameUnavailabilityReason

The reason for unavailability.