Microsoft.VideoIndexer (stable:2025-03-01)

2025/02/20 • 12 new methods

Operations_List (new)
Description :  Lists all of the available Azure Video Indexer provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.VideoIndexer/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Resource Provider. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
actionType:
{
Description: Indicates the action type. ,
Required: False ,
}
string ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_CheckNameAvailability (new)
Description :  Checks that the Video Indexer account name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityParameters:
{
Description: The name of the Video Indexer account. Name must be unique globally ,
Required: True ,
}
{
name:
{
Description: The VideoIndexer account name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.VideoIndexer/accounts ,
Enum:
{
Microsoft.VideoIndexer/accounts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: 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. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false. ,
Enum:
{
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets an error message explaining the Reason value in more detail. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_List (new)
Description :  List all Azure Video Indexer accounts available under the subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of accounts and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_ListByResourceGroup (new)
Description :  List all Azure Video Indexer accounts available under the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of accounts and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Get (new)
Description :  Gets the properties of an Azure Video Indexer account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Update (new)
Description :  Updates the properties of an existing Azure Video Indexer account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the current Azure Video Indexer account. ,
Required: False ,
}
{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_CreateOrUpdate (new)
Description :  Creates or updates an Azure Video Indexer account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the Azure Video Indexer account. ,
Required: False ,
}
{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: List of account properties ,
Required: False ,
}
{
tenantId:
{
Description: The account's tenant id ,
Required: False ,
}
string ,
accountId:
{
Description: The account's data-plane ID. This can be set only when connecting an existing classic account ,
Required: False ,
}
string ,
accountName:
{
Description: The account's name ,
Required: False ,
}
string ,
storageServices:
{
Description: The storage services details ,
Required: False ,
}
{
resourceId:
{
Description: The storage services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
openAiServices:
{
Description: The openAi services details ,
Required: False ,
}
{
resourceId:
{
Description: The openAi services resource id ,
Format: arm-id ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: The user assigned identity to be used to grant permissions ,
Required: False ,
}
string ,
}
,
totalSecondsIndexed:
{
Description: An integer representing the total seconds that have been indexed on the account ,
Format: int32 ,
Required: False ,
}
integer ,
totalMinutesIndexed:
{
Description: An integer representing the total minutes that have been indexed on the account ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets the status of the account at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Accounts_Delete (new)
Description :  Delete an Azure Video Indexer account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Generate_AccessToken (new)
Description :  Generate an Azure Video Indexer access token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for generating access token ,
Required: False ,
}
{
permissionType:
{
Description: The requested permission ,
Enum:
{
Contributor: No description available. ,
Reader: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The requested media type ,
Enum:
{
Video: No description available. ,
Account: No description available. ,
Project: No description available. ,
}
,
Required: True ,
}
enum ,
videoId:
{
Description: The video ID ,
Required: False ,
}
string ,
projectId:
{
Description: The project ID ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Generate_RestrictedViewerAccessToken (new)
Description :  Generate an Azure Video Indexer restricted viewer access token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for generating restricted viewer access token ,
Required: False ,
}
{
scope:
{
Description: The requested media type ,
Enum:
{
Video: No description available. ,
Account: No description available. ,
Project: No description available. ,
}
,
Required: True ,
}
enum ,
videoId:
{
Description: The video ID ,
Required: False ,
}
string ,
projectId:
{
Description: The project ID ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Generate_ExtensionAccessToken (new)
Description :  Generate an Azure Video Indexer access token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateExtensionAccessToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for generating access token ,
Required: False ,
}
{
permissionType:
{
Description: The requested permission ,
Enum:
{
Contributor: No description available. ,
Reader: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The requested media type ,
Enum:
{
Video: No description available. ,
Account: No description available. ,
}
,
Required: True ,
}
enum ,
extensionId:
{
Description: The extension's resource ID ,
Required: True ,
}
string ,
videoId:
{
Description: The video ID ,
Required: False ,
}
string ,
tokenLifetimeInSeconds:
{
Description: Lifetime of the access token (in seconds). Default value: 3600 (1 hour), Max value: 43200 (12 hours). Setting this value is enabled for tokens in 'Video' scope. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Generate_ExtensionRestrictedViewerAccessToken (new)
Description :  Generate an Azure Video Indexer restricted viewer access token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateExtensionRestrictedViewerAccessToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the Azure Video Indexer account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for generating restricted viewer access token ,
Required: False ,
}
{
scope:
{
Description: The requested media type ,
Enum:
{
Video: No description available. ,
Account: No description available. ,
}
,
Required: True ,
}
enum ,
extensionId:
{
Description: The extension's resource ID ,
Required: True ,
}
string ,
videoId:
{
Description: The video ID ,
Required: False ,
}
string ,
tokenLifetimeInSeconds:
{
Description: Lifetime of the access token (in seconds). Default value: 3600 (1 hour), Max value: 43200 (12 hours). Setting this value is enabled for tokens in 'Video' scope. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}