Sign in

v7

latestSwagger 2.0raw.githubusercontent.com2019-12-163581169.9 KB

Checks whether the Batch account name is available in the specified region.

post/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability

Path parameters

locationNamestring required

The desired region for the name check.

subscriptionIdstring required

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

Query parameters

api-versionstring required

The API version to be used with the HTTP request.

Request body

namestring required

The name to check for availability

type'Microsoft.Batch/batchAccounts' required

The resource type. Must be set to Microsoft.Batch/batchAccounts

Response

Success. Returns details about whether a Batch account name is available.

nameAvailableboolean

Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.

reason'Invalid' | 'AlreadyExists'

Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.

messagestring

Gets an error message explaining the Reason value in more detail.