Share via

Accounts - Check Name Availability

Service:
Azure Video Indexer
API Version:
2025-04-01

Checks that the Video Indexer account name is valid and is not already in use.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2025-04-01

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
name True

string

The VideoIndexer account name.
type True

Type

The type of resource, Microsoft.VideoIndexer/accounts

Responses

Name Type Description
200 OK

CheckNameAvailabilityResult

OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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 free account name availability
Check taken account name availability

Check free account name availability

Sample request

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2025-04-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

Sample response

Status code:
200 
{
  "nameAvailable": true
}

Check taken account name availability

Sample request

POST https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/providers/Microsoft.VideoIndexer/checkNameAvailability?api-version=2025-04-01

{
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts"
}

Sample response

Status code:
200 
{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Resource name already exists"
}

Definitions

Name Description
AccountCheckNameAvailabilityParameters

The parameters used to check the availability of the Video Indexer account name.
CheckNameAvailabilityResult

The CheckNameAvailability operation response.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
Reason

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

The type of resource, Microsoft.VideoIndexer/accounts

AccountCheckNameAvailabilityParameters

Object

The parameters used to check the availability of the Video Indexer account name.

Name Type Description
name

string

The VideoIndexer account name.
type

Type

The type of resource, Microsoft.VideoIndexer/accounts

CheckNameAvailabilityResult

Object

The CheckNameAvailability operation response.

Name Type Description
message

string

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

boolean

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.
reason

Reason

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

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

Reason

Enumeration

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

Value Description
AlreadyExists

Type

Enumeration

The type of resource, Microsoft.VideoIndexer/accounts

Value Description
Microsoft.VideoIndexer/accounts