Accounts - Check Name Availability

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=2024-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

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=2024-01-01

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

Sample response

{
  "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=2024-01-01

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

Sample response

{
  "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.

ErrorDefinition

Error definition.

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

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

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.

ErrorDefinition

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.

details

ErrorDefinition[]

Internal error details.

message

string

Description of the error.

ErrorResponse

Error response.

Name Type Description
error

ErrorDefinition

The error details.

Reason

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

Name Type Description
AlreadyExists

string

Type

The type of resource, Microsoft.VideoIndexer/accounts

Name Type Description
Microsoft.VideoIndexer/accounts

string