Accounts - Check Name Availability

Service:

Visual Studio

API Version:

2017-11-01-preview

Accounts_CheckNameAvailability
Checks if the specified Visual Studio Team Services account name is available. Resource name can be either an account name or an account name and PUID.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.visualstudio/checkNameAvailability?api-version=2017-11-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The Azure subscription identifier.
api-version	query	True	string	API Version

Request Body

Name	Type	Description
resourceName	string	The name of the resource to check availability for.
resourceType	string	The type of resource to check availability for.

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResult	The operation succeeded. The response contains the result of the name availability check.

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 availability of an account name

Sample Request

HTTP

POST https://management.azure.com/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/providers/microsoft.visualstudio/checkNameAvailability?api-version=2017-11-01-preview

{
  "resourceType": "Account",
  "resourceName": "ExampleName"
}

Sample Response

Status code:

200

{
  "nameAvailable": true
}

Definitions

Name	Description
CheckNameAvailabilityParameter	The body of a POST request to check name availability.
CheckNameAvailabilityResult	The response to a name availability request.

CheckNameAvailabilityParameter

The body of a POST request to check name availability.

Name	Type	Description
resourceName	string	The name of the resource to check availability for.
resourceType	string	The type of resource to check availability for.

CheckNameAvailabilityResult

The response to a name availability request.

Name	Type	Description
message	string	The message describing the detailed reason.
nameAvailable	boolean	The value which indicates whether the provided name is available.