|
1 | 1 | ---
|
2 |
| -title: Deploy Azure Video Indexer with ARM template |
3 |
| -description: Learn how to create an Azure Video Indexer account by using Azure Resource Manager (ARM) template. |
| 2 | +title: Deploy Azure Video Indexer by using an ARM template |
| 3 | +description: Learn how to create an Azure Video Indexer account by using an Azure Resource Manager (ARM) template. |
4 | 4 | ms.topic: tutorial
|
5 | 5 | ms.date: 05/23/2022
|
6 | 6 | ms.author: juliako
|
7 | 7 | ---
|
8 | 8 |
|
9 |
| -# Tutorial: deploy Azure Video Indexer with ARM template |
| 9 | +# Tutorial: Deploy Azure Video Indexer by using an ARM template |
10 | 10 |
|
11 |
| -## Overview |
12 |
| - |
13 |
| -In this tutorial, you will create an Azure Video Indexer account by using Azure Resource Manager (ARM) template (preview). |
14 |
| -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. |
| 11 | +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. |
15 | 12 |
|
16 | 13 | > [!NOTE]
|
17 |
| -> This sample is *not* for connecting an existing Azure Video Indexer classic account to an ARM-based Azure Video Indexer account. |
18 |
| -> For full documentation on Azure Video Indexer API, visit the [Developer portal](https://aka.ms/avam-dev-portal) page. |
19 |
| -> For the latest API version for Microsoft.VideoIndexer, see the [template reference](/azure/templates/microsoft.videoindexer/accounts?tabs=bicep). |
| 14 | +> This sample is *not* for connecting an existing Azure Video Indexer classic account to a Resource Manager-based Azure Video Indexer account. |
| 15 | +> |
| 16 | +> For full documentation on the Azure Video Indexer API, visit the [developer portal](https://aka.ms/avam-dev-portal). For the latest API version for *Microsoft.VideoIndexer*, see the [template reference](/azure/templates/microsoft.videoindexer/accounts?tabs=bicep). |
20 | 17 |
|
21 | 18 | ## Prerequisites
|
22 | 19 |
|
23 |
| -* An Azure Media Services (AMS) account. You can create one for free through the [Create AMS Account](/azure/media-services/latest/account-create-how-to). |
| 20 | +You need an Azure Media Services account. You can create one for free through [Create a Media Services account](/azure/media-services/latest/account-create-how-to). |
24 | 21 |
|
25 | 22 | ## Deploy the sample
|
26 | 23 |
|
27 | 24 | ----
|
28 | 25 |
|
29 |
| -### Option 1: Click the "Deploy To Azure Button", and fill in the missing parameters |
| 26 | +### Option 1: Select the button for deploying to Azure, and fill in the missing parameters |
30 | 27 |
|
31 | 28 | [](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fmedia-services-video-indexer%2Fmaster%2FARM-Quick-Start%2Favam.template.json)
|
32 | 29 |
|
33 | 30 | ----
|
34 | 31 |
|
35 |
| -### Option 2 : Deploy using PowerShell Script |
| 32 | +### Option 2: Deploy by using a PowerShell script |
36 | 33 |
|
37 |
| -1. Open The [template file](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/ARM-Quick-Start/avam.template.json) file and inspect its content. |
38 |
| -2. Fill in the required parameters (see below) |
39 |
| -3. Run the Following PowerShell commands: |
| 34 | +1. Open the [template file](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/ARM-Quick-Start/avam.template.json) and inspect its contents. |
| 35 | +2. Fill in the required parameters. |
| 36 | +3. Run the following PowerShell commands: |
40 | 37 |
|
41 |
| - * Create a new Resource group on the same location as your Azure Video Indexer account, using the [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup) cmdlet. |
| 38 | + * Create a new resource group on the same location as your Azure Video Indexer account by using the [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup) cmdlet. |
42 | 39 |
|
43 |
| - ```powershell |
44 |
| - New-AzResourceGroup -Name myResourceGroup -Location eastus |
45 |
| - ``` |
| 40 | + ```powershell |
| 41 | + New-AzResourceGroup -Name myResourceGroup -Location eastus |
| 42 | + ``` |
46 | 43 |
|
47 |
| - * Deploy the template to the resource group using the [New-AzResourceGroupDeployment](/powershell/module/az.resources/new-azresourcegroupdeployment) cmdlet. |
| 44 | + * Deploy the template to the resource group by using the [New-AzResourceGroupDeployment](/powershell/module/az.resources/new-azresourcegroupdeployment) cmdlet. |
48 | 45 |
|
49 |
| - ```powershell |
50 |
| - New-AzResourceGroupDeployment -ResourceGroupName myResourceGroup -TemplateFile ./avam.template.json |
51 |
| - ``` |
| 46 | + ```powershell |
| 47 | + New-AzResourceGroupDeployment -ResourceGroupName myResourceGroup -TemplateFile ./avam.template.json |
| 48 | + ``` |
52 | 49 |
|
53 | 50 | > [!NOTE]
|
54 |
| -> If you would like to work with bicep format, see [Deploy by using Bicep](./deploy-with-bicep.md). |
| 51 | +> If you want to work with Bicep format, see [Deploy by using Bicep](./deploy-with-bicep.md). |
55 | 52 |
|
56 | 53 | ## Parameters
|
57 | 54 |
|
58 | 55 | ### name
|
59 | 56 |
|
60 | 57 | * Type: string
|
61 |
| -* Description: Specifies the name of the new Azure Video Indexer account. |
62 |
| -* required: true |
| 58 | +* Description: The name of the new Azure Video Indexer account. |
| 59 | +* Required: true |
63 | 60 |
|
64 | 61 | ### location
|
65 | 62 |
|
66 | 63 | * Type: string
|
67 |
| -* Description: Specifies the Azure location where the Azure Video Indexer account should be created. |
| 64 | +* Description: The Azure location where the Azure Video Indexer account should be created. |
68 | 65 | * Required: false
|
69 | 66 |
|
70 | 67 | > [!NOTE]
|
71 |
| -> You need to deploy Your Azure Video Indexer account in the same location (region) as the associated Azure Media Services(AMS) resource exists. |
| 68 | +> You need to deploy your Azure Video Indexer account in the same location (region) as the associated Azure Media Services resource. |
72 | 69 |
|
73 | 70 | ### mediaServiceAccountResourceId
|
74 | 71 |
|
75 | 72 | * Type: string
|
76 |
| -* Description: The Resource ID of the Azure Media Services(AMS) resource. |
| 73 | +* Description: The resource ID of the Azure Media Services resource. |
77 | 74 | * Required: true
|
78 | 75 |
|
79 | 76 | ### managedIdentityId
|
80 | 77 |
|
81 | 78 | * Type: string
|
82 |
| -* Description: The Resource ID of the Managed Identity used to grant access between Azure Media Services(AMS) resource and the Azure Video Indexer account. |
| 79 | +* 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. |
83 | 80 | * Required: true
|
84 | 81 |
|
85 | 82 | ### tags
|
86 | 83 |
|
87 | 84 | * Type: object
|
88 |
| -* Description: Array of objects that represents custom user tags on the Azure Video Indexer account |
89 |
| -
|
90 |
| - Required: false |
| 85 | +* Description: The array of objects that represents custom user tags on the Azure Video Indexer account. |
| 86 | +* Required: false |
91 | 87 |
|
92 | 88 | ## Reference documentation
|
93 | 89 |
|
94 | 90 | If you're new to Azure Video Indexer, see:
|
95 | 91 |
|
96 |
| -* [Azure Video Indexer Documentation](./index.yml) |
97 |
| -* [Azure Video Indexer Developer Portal](https://api-portal.videoindexer.ai/) |
98 |
| -* After completing this tutorial, head to other Azure Video Indexer samples, described on [README.md](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/README.md) |
| 92 | +* [Azure Video Indexer documentation](./index.yml) |
| 93 | +* [Azure Video Indexer developer portal](https://api-portal.videoindexer.ai/) |
| 94 | +
|
| 95 | +After you complete this tutorial, head to other Azure Video Indexer samples described in [README.md](https://github.com/Azure-Samples/media-services-video-indexer/blob/master/README.md). |
99 | 96 |
|
100 | 97 | If you're new to template deployment, see:
|
101 | 98 |
|
102 | 99 | * [Azure Resource Manager documentation](../azure-resource-manager/index.yml)
|
103 |
| -* [Deploy Resources with ARM Template](../azure-resource-manager/templates/deploy-powershell.md) |
104 |
| -* [Deploy Resources with Bicep and Azure CLI](../azure-resource-manager/bicep/deploy-cli.md) |
| 100 | +* [Deploy resources with ARM templates](../azure-resource-manager/templates/deploy-powershell.md) |
| 101 | +* [Deploy resources with Bicep and the Azure CLI](../azure-resource-manager/bicep/deploy-cli.md) |
105 | 102 |
|
106 | 103 | ## Next steps
|
107 | 104 |
|
108 |
| -[Connect an existing classic paid Azure Video Indexer account to ARM-based account](connect-classic-account-to-arm.md) |
| 105 | +Connect a [classic paid Azure Video Indexer account to a Resource Manager-based account](connect-classic-account-to-arm.md). |
0 commit comments