Check Hosted Service Name Availability
Updated: June 7, 2012
The Check Hosted Service Name Availability operation checks for the availability of the specified cloud service name.
Request
The Check Hosted Service Name Availability request may be specified as follows. Replace <subscription-id> with your subscription ID and <cloudservice-name> with the cloud service name that you would like to use.
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET |
|
HTTP/1.1 |
URI Parameters
None.
Request Headers
The following table describes the request headers.
| Request Header | Description |
|---|---|
|
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01 or later. For more information about versioning headers, see Service Management Versioning. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response Header | Description |
|---|---|
|
x-ms-request-id |
A value that uniquely identifies a request made against the management service. |
Response Body
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?> <AvailabilityResponse xmlns=”http://schemas.microsoft.com/windowsazure”> <Result>name-availability</Result> <Reason>reason</Reason> </AvailabilityResponse>
The following table describes the key elements in the response body:
| Element name | Description |
|---|---|
|
Result |
A boolean value that indicates whether the name is available for you to use. True if the name is available; otherwise false. For versions before 2013-03-01, the operation returned true for non-taken names even if they were reserved or profane. With version headers of 2013-03-01 and later, the operation returns false for reserved or profane words. |
|
Reason |
Describes why the name cannot be used to create the cloud service. The Reason element is only available using version 2013-03-01 or higher. |
Authorization
Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.
Remarks
None.