Edit

Tutorial: Deploy Azure Video Indexer by using an ARM template

  • Article
  • 2 minutes to read

Important

Face identification, customization and celebrity recognition features access is limited based on eligibility and usage criteria in order to support our Responsible AI principles. Face identification, customization and celebrity recognition features are only available to Microsoft managed customers and partners. Use the Face Recognition intake form to apply for access.

In this tutorial, you'll create an Azure Video Indexer account by using the Azure Resource Manager template (ARM template, which is in preview). The resource will be deployed to your subscription and will create the Azure Video Indexer resource based on parameters defined in the avam.template file.

Note

This sample is not for connecting an existing Azure Video Indexer classic account to a Resource Manager-based Azure Video Indexer account.

For full documentation on the Azure Video Indexer API, visit the developer portal. For the latest API version for Microsoft.VideoIndexer, see the template reference.

Prerequisites

You need an Azure Media Services account. You can create one for free through Create a Media Services account.

Deploy the sample

Option 1: Select the button for deploying to Azure, and fill in the missing parameters

Deploy to Azure

Option 2: Deploy by using a PowerShell script

  1. Open the template file and inspect its contents.

  2. Fill in the required parameters.

  3. Run the following PowerShell commands:

    • Create a new resource group on the same location as your Azure Video Indexer account by using the New-AzResourceGroup cmdlet.

      New-AzResourceGroup -Name myResourceGroup -Location eastus

    • Deploy the template to the resource group by using the New-AzResourceGroupDeployment cmdlet.

      New-AzResourceGroupDeployment -ResourceGroupName myResourceGroup -TemplateFile ./avam.template.json

Note

If you want to work with Bicep format, see Deploy by using Bicep.

Parameters

name

  • Type: string
  • Description: The name of the new Azure Video Indexer account.
  • Required: true

location

  • Type: string
  • Description: The Azure location where the Azure Video Indexer account should be created.
  • Required: false

Note

You need to deploy your Azure Video Indexer account in the same location (region) as the associated Azure Media Services resource.

mediaServiceAccountResourceId

  • Type: string
  • Description: The resource ID of the Azure Media Services resource.
  • Required: true

managedIdentityId

Note

User assigned managed Identify must have at least Contributor role on the Media Service before deployment, when using System Assigned Managed Identity the Contributor role should be assigned after deployment.

  • Type: string
  • Description: The resource ID of the managed identity that's used to grant access between Azure Media Services resource and the Azure Video Indexer account.
  • Required: true

tags

  • Type: object
  • Description: The array of objects that represents custom user tags on the Azure Video Indexer account.
  • Required: false

Reference documentation

If you're new to Azure Video Indexer, see:

After you complete this tutorial, head to other Azure Video Indexer samples described in README.md.

If you're new to template deployment, see:

Next steps

Connect a classic paid Azure Video Indexer account to a Resource Manager-based account.