Sign in
Location

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.

Parameters

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

Request body

namestring required

The name to check for availability

type'Microsoft.Batch/batchAccounts' required

The result of the request to list operations.

Response

The request has succeeded.

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.

Changes

Changed in 2 of the 20 revisions of this API.22

  • 2015-12-01bd5ddd70882521See the full diff
    • ●

      deleted the path request parameter subscriptionId

      request-parameter-removed

    • ●

      deleted the query request parameter api-version

      request-parameter-removed

    • ○

      api tag Location added

      api-tag-added

  • 2015-12-01a4db6a42da8a1See the full diff
    • ○

      endpoint added

      endpoint-added